Generator::getTitle(): fall back to file name if title is missing #820
+191
−13
Conversation
This file contains 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
When the documentation `title` attribute is missing, a title would still be included in the docs, but not contain any (useful) information. Fixed now by falling back to the XML document file name and splitting the name into words. Includes tests.
fredden
approved these changes
Feb 15, 2025
|
Thanks for reviewing @fredden ! |
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.
Description
When the documentation
titleattribute is missing, a title would still be included in the docs, but not contain any (useful) information.Fixed now by falling back to the XML document file name and splitting the name into words.
Includes tests.
Suggested changelog entry
Generators: gracefully handle missing title attribute
Related issues/external references
This PR is part of a series of PRs which will add a complete set of tests (and improvements) for the Generator feature.
Also see: #671 and other PR with the Core Component: Generators label.
Types of changes