Skip to content

Allow documenting function via comment on DeclareGlobalName#343

Merged
fingolfin merged 1 commit intomasterfrom
codex/declareglobalname-itemtype
Mar 11, 2026
Merged

Allow documenting function via comment on DeclareGlobalName#343
fingolfin merged 1 commit intomasterfrom
codex/declareglobalname-itemtype

Conversation

@fingolfin
Copy link
Member

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

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>
@fingolfin fingolfin linked an issue Mar 11, 2026 that may be closed by this pull request
@fingolfin fingolfin enabled auto-merge (squash) March 11, 2026 14:26
@codecov
Copy link

codecov bot commented Mar 11, 2026

Codecov Report

❌ Patch coverage is 78.57143% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.61%. Comparing base (a04aa09) to head (5d36023).
⚠️ Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
gap/Parser.gi 78.57% 6 Missing ⚠️
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     
Files with missing lines Coverage Δ
gap/Parser.gi 96.20% <78.57%> (-0.56%) ⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@fingolfin fingolfin merged commit 397ceb1 into master Mar 11, 2026
7 of 8 checks passed
@fingolfin fingolfin deleted the codex/declareglobalname-itemtype branch March 11, 2026 14:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make using DeclareGlobalName for functions work

1 participant