Support authoring a single anonymous topics section #421
Conversation
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
The initial implementation of anonymous topics sections didn’t account for the use-case of a single, anonymous topic section. The current markup parsing logic expects to find at least one H3 heading inside a valid topic section. So while the rest of DocC’s navigator logic was ready to handle this markup, the initial check for the existence and range of the task group in the markup failed to return a value for this use case. Resolves rdar://100994549
DocC supports anonymous topic sections so this error is no longer needed.
|
@swift-ci please test |
franklinsch
approved these changes
Nov 11, 2022
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.
Bug/issue #, if applicable: rdar://100994549, resolves #404
Summary
The initial implementation of anonymous topics sections didn’t
account for the use-case of a single, anonymous topic section.
The current markup parsing logic expects to find at least one H3 heading
inside a valid topic section. So while the rest of DocC’s navigator
logic was ready to handle this markup, the initial check
for the existence and range of the task group in the markup
failed to return a value for this use case.
Testing
Confirm that the DocC catalog included in #404 renders as expected.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded