Give phpdoc reference stubs proper titles so they appear in the ToC - #4116
Open
lacatoire wants to merge 1 commit into
Open
Give phpdoc reference stubs proper titles so they appear in the ToC#4116lacatoire wants to merge 1 commit into
lacatoire wants to merge 1 commit into
Conversation
The 'Tag reference' and 'Inline tag reference' tables of content rendered <Unknown> entries for the six .rst files whose only body was a .. include:: <other>.rst line. Without a top-level title, the toctree could not extract a label for them. Replace each include with a proper RST title matching the tag name plus a short cross-reference and a one-liner that spells out the variant's specific semantics. Users landing on each URL still get a clear pointer to the canonical reference page. Fixes phpDocumentor#3759
lacatoire
force-pushed
the
fix/issue-3759-phpdoc-reference-toc
branch
from
April 17, 2026 20:13
eb8cfba to
8000636
Compare
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
1 participant
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 Tag reference and Inline tag reference tables of content on docs.phpdoc.org rendered
<Unknown>entries for six.rstfiles whose only body was a.. include:: <other>.rstline (see #3759). Without a top-level title, the toctree could not extract a label for them.Replace each include with a proper RST title matching the tag name plus a short cross-reference and a one-liner that spells out the variant's specific semantics. Users landing on each URL still get a clear pointer to the canonical reference page.
Affected files:
docs/references/phpdoc/tags/property-read.rst(@property-read)docs/references/phpdoc/tags/property-write.rst(@property-write)docs/references/phpdoc/inline-tags/example.rst(@example)docs/references/phpdoc/inline-tags/internal.rst(@internal)docs/references/phpdoc/inline-tags/link.rst(@link)docs/references/phpdoc/inline-tags/see.rst(@see)Inline-tag titles follow the existing
inheritdoc.rstconvention (bare@tag, no braces) so theinline-tagstoctree stays visually uniform.Fixes #3759