Improve Documentation and Fix Bugs #87
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
6 tasks
…t into 44-better-documentation
…ctfail_subprocess
AutonomicPerfectionist
changed the title
ryanmrichard
previously approved these changes
Sep 11, 2023
|
This looks great!!! The only minor suggestion I had was to link from the README to the examples/tutorials. |
Co-authored-by: Ryan Richard <[email protected]>
|
@ryanmrichard I committed your suggestion, so if everything else looks good feel free to merge |
Sounds good. I'll merge it whenever CI passes (at lease I assume it'll pass...). |
|
🚀 [bumpr] Bumped! New version:v0.1.7 Changes:v0.1.6...v0.1.7 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Is this pull request associated with an issue(s)?
Fixes #44
Description
This PR improves documentation. It updates the README to include a bit of reasoning behind the project, and includes the intro of the README in the index.rst of the documentation.
Edit
While adding types to the various signatures, multiple bugs were found, such as incorrectly handling
CMAKEPP_LANG_DEBUG_MODEand not accounting for re-execution when comparing section IDs. Additionally, the type checking identified areas where we were reconstructing execution unit objects when they already existed.TODOs
Note
Method parameter types have been refined to pointer types, meaning CMakePP/CMakePPLang#106 must be fixed before merging this
Note 2
This PR is getting very large, so I've decided to cut it off for now and finish the other documentation updates and clean up in a subsequent PR