Fix enable docs for builtin constants#14571
Merged
straight-shoota merged 1 commit intocrystal-lang:masterfrom May 9, 2024
Merged
Fix enable docs for builtin constants#14571straight-shoota merged 1 commit intocrystal-lang:masterfrom
straight-shoota merged 1 commit intocrystal-lang:masterfrom
Conversation
The builtins are created inside the initializer. At this point `wants_doc?` is always `false` becase it is only assigned after the initializer.
straight-shoota
added
kind:bug
HertzDevil
approved these changes
May 7, 2024
1 task
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The builtins are created inside the initializer. At this point
wants_doc?is alwaysfalsebecase the doc generator only set it totrueafter the initializer.I don't think there's any noticable impact from having a dozend doc strings assigned in every program AST, even without
wants_doc. Skipping docs is an optimization that pays out when parsing huge program ASTs. But for these few doc strings, there shouldn't be any issue.The doc strings are literals, so they don't even occupy any memory (not that it would hurt much if it did).
Follow-up to #14276