feat(graindoc)!: Support docblocks on submodules #1684
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
phated
requested review from
ospencer,
peblair,
marcusroberts and
jozanza
as code owners
ospencer
approved these changes
Feb 20, 2023
This was referenced Feb 20, 2023
This was referenced Mar 20, 2023
av8ta
pushed a commit
to av8ta/grain
that referenced
this pull request
Apr 11, 2023
* chore(graindoc): Refactor separation between attributes & docblock * feat(graindoc)!: Support docblocks on submodules * chore(stdlib): Regenerate markdown docs
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.
This updates graindoc to support submodules. Since modules need to be processed recursively, I needed to refactor most of the graindoc internals. This was a really good refactor because it makes a clear separation between the attribute parsing, the docblock data types, and the markdown generation phase. Both the docblock collection and markdown generation are recursive so we can start at the top of the program tree and call
Docblock.for_signature_itemsand theDocblock.to_markdownon the results and everything gets printed.Since we don't have any submodules in the stdlib at the moment, I've run this against #1479 and pushed the updated docs as 4dfc7c5
Closes #1621