Refactor doc generation #95
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
added 3 commits
September 4, 2023 21:06
Factor out functions that do walk-tree and that answer questions about the model (e.g. is_optional()? for a particular field). Those functions are reusable for several tasks and should not be tied to document generation only. The implementations of helper functions are now also cleaner, and using consistent naming of parameters. The ifex_ast_doc.py was modified accordingly to make use of the new module ifex_model_walk for walk-function and other helpers. Other than that, very little change to the actual documentation generation logic. Signed-off-by: Gunnar Andersson <gunnar_dev@[email protected]>
Signed-off-by: Gunnar Andersson <gunnar_dev@[email protected]>
Signed-off-by: Gunnar Andersson <gunnar_dev@[email protected]>
gunnarx
force-pushed
the
refactor_doc_generation
branch
from
6839757
to
5632db9
Compare
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.
Pushing an old refactor job.
This separates the functions that "introspect" the language definition in ifex_ast.py, away from the document generation task in ifex_ast_doc.py.
Because these functions that "introspect" the model that defines the core IDL, are reusable for other things than document definition. The implementation of this is now more complete, robust, and cleaner too.