Allow documenting function via comment on DeclareGlobalName#343
Merged
Allow documenting function via comment on DeclareGlobalName#343
Conversation
Keep DeclareGlobalName entries documented as variables by default, but promote them to functions when @arguments or @returns provides function-style documentation. Preserve explicit @ItemType overrides and document the resulting behavior in the manual and regression fixtures. AI assistance disclosure: Codex assisted with implementing the parser change, updating the manual text, and revising the test fixtures and expected output. Co-authored-by: Codex <codex@openai.com>
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #343 +/- ##
==========================================
- Coverage 91.77% 91.61% -0.16%
==========================================
Files 13 13
Lines 2566 2589 +23
==========================================
+ Hits 2355 2372 +17
- Misses 211 217 +6
🚀 New features to boost your workflow:
|
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
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.
Keep DeclareGlobalName entries documented as variables by default,
but promote them to functions when @arguments or @returns provides
function-style documentation. Preserve explicit @ItemType
overrides and document the resulting behavior in the manual and
regression fixtures.
AI assistance disclosure: Codex assisted with implementing the
parser change, updating the manual text, and revising the test
fixtures and expected output.
Co-authored-by: Codex codex@openai.com