Skip to content

Avoid AutoDoc text outside of any chapter - #52

Open
fingolfin wants to merge 1 commit into
QEC-pages:mainfrom
fingolfin:mh-ai/autodoc-text-placement
Open

fingolfin wants to merge 1 commit into
QEC-pages:mainfrom
fingolfin:mh-ai/autodoc-text-placement

Conversation

@fingolfin

Copy link
Copy Markdown
Contributor

Upcoming AutoDoc versions (gap-packages/AutoDoc#390) warn about plain text that AutoDoc discards, or that the manual shows inside a preceding section because it is added to the chapter after that section. Here, the banner at the top of doc/body.autodoc and the #! header of examples/cyclic.g are such discarded text; they become ordinary comments. The manual does not change.

AI disclosure: prepared with Claude Code, which found the cause, wrote the change, and checked that the manual builds without warnings.

🤖 Generated with Claude Code

The banner at the top of doc/body.autodoc and the header comment of
examples/cyclic.g are AutoDoc text read before any @chapter, which
AutoDoc discards, and upcoming versions warn about. Make them
ordinary comments. The manual does not change.

Assisted-by: Generative AI

This branch has not been deployed

No deployments
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