Skip to content

Support reading makedoc.g from other directories than the package dir; deprecate calling AutoDoc() with a package name#365

Merged
fingolfin merged 5 commits into
masterfrom
codex/autodoc-input-filename
May 3, 2026
Merged

Support reading makedoc.g from other directories than the package dir; deprecate calling AutoDoc() with a package name#365
fingolfin merged 5 commits into
masterfrom
codex/autodoc-input-filename

Conversation

@fingolfin
Copy link
Copy Markdown
Member

Fall back to INPUT_FILENAME() before DirectoryCurrent().

AI assistance: Codex implemented the change and tests.

Co-authored-by: Codex codex@openai.com

@codecov
Copy link
Copy Markdown

codecov Bot commented May 3, 2026

Codecov Report

❌ Patch coverage is 78.94737% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 93.17%. Comparing base (21c6ea3) to head (7154f17).
⚠️ Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
gap/Magic.gi 78.94% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #365      +/-   ##
==========================================
+ Coverage   93.09%   93.17%   +0.07%     
==========================================
  Files          13       13              
  Lines        2926     2944      +18     
==========================================
+ Hits         2724     2743      +19     
+ Misses        202      201       -1     
Files with missing lines Coverage Δ
gap/Magic.gd 100.00% <ø> (ø)
gap/Magic.gi 73.91% <78.94%> (+1.52%) ⬆️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@fingolfin fingolfin force-pushed the codex/autodoc-input-filename branch from 2c1ffbd to d1d78a3 Compare May 3, 2026 16:57
fingolfin and others added 3 commits May 3, 2026 18:14
Fall back to INPUT_FILENAME() before DirectoryCurrent().

AI assistance: Codex implemented the change and tests.

Co-authored-by: Codex <codex@openai.com>
Specifically if a package name is passed to AutoDoc; or opions are
passed in via GAP's global options system.
@fingolfin fingolfin force-pushed the codex/autodoc-input-filename branch from d1d78a3 to 2c768e3 Compare May 3, 2026 17:14
@fingolfin fingolfin changed the title magic: Use INPUT_FILENAME() for default pkgdir Support reading makedoc.g from other directories than the package dir; deprecate calling AutoDoc() with a package name May 3, 2026
fingolfin and others added 2 commits May 3, 2026 18:41
Update the tutorial to describe the makedoc.g-based default.

Refresh the generated tutorial chapter fixture.

AI assistance: Codex updated the tutorial and fixture.

Co-authored-by: Codex <codex@openai.com>
@fingolfin fingolfin merged commit 91eceab into master May 3, 2026
7 of 8 checks passed
@fingolfin fingolfin deleted the codex/autodoc-input-filename branch May 3, 2026 17:50
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.

1 participant