feat(graindoc)!: Replace module attribute with docblock on module header #1647
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,
jozanza and
marcusroberts
as code owners
phated
force-pushed
the
phated/graindoc-modules
branch
2 times, most recently
from
05566bf
to
48249c1
Compare
ospencer
approved these changes
Feb 1, 2023
phated
force-pushed
the
phated/graindoc-modules
branch
from
48249c1
to
316169c
Compare
This was referenced Mar 20, 2023
av8ta
pushed a commit
to av8ta/grain
that referenced
this pull request
Apr 11, 2023
…der (grain-lang#1647) chore(compiler): Add module_name to typedtree chore(graindoc): Avoid catch-all case for ttop variants chore(stdlib): Remove module attribute from module docblocks fix(stdlib)!: Use correct casing for BigInt module name chore(stdlib): Regenerate docs chore(graindoc): Cleanup module name defaults & utilities
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 removes our custom
@moduleattribute in a docblock and instead relies on a docblock attached to the module header (hooray module anchor points!).Also, I updated the stdlib to avoid using
@module, which caught one problem with theBigintmodule header which generally should beBigIntand the docs were different.One benefit you'll noticed from the regenerated docs is that the docs produced for runtime are more accurate because we have accurate module naming in the files.
Ref #1621 (still plenty to do before it is done).