Emit language specific topic sections in the markdown representation of automatic curation #856
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
3 tasks
d-ronnqvist
force-pushed
the
generate-language-specific-curation-markdown
branch
from
7e25cd0 to
2683f3d
Compare
3 tasks
d-ronnqvist
force-pushed
the
generate-language-specific-curation-markdown
branch
from
2683f3d to
73dfe05
Compare
d-ronnqvist
force-pushed
the
generate-language-specific-curation-markdown
branch
from
73dfe05 to
7564600
Compare
QuietMisdreavus
approved these changes
Mar 28, 2024
Comment on lines
186
to
193
| // Sort Swift before other languages | ||
| if lhs == .swift { | ||
| return true | ||
| } else if rhs == .swift { | ||
| return false | ||
| } | ||
| // Otherwise, sort by ID for a stable order | ||
| return lhs.id < rhs.id |
There was a problem hiding this comment.
This sort comparator rings a bell for the code i've been sifting through recently, and i wonder if we should implement Comparable or some other kind of broadly-available comparator so we don't have to duplicate this code.
|
@swift-ci Please test |
|
@swift-ci please test |
|
@swift-ci please test |
d-ronnqvist
added a commit
to d-ronnqvist/swift-docc
that referenced
this pull request
May 23, 2024
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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://124527905
Summary
This builds on #854 to emit language specific topic sections in the markdown representation of automatic curation from
docc process-catalog emit-generated-curationDependencies
None
Testing
Run
docc process-catalog emit-generated-curationon a project with language refinements (for example " Tests/SwiftDocCTests/Test Bundles/GeometricalShapes.docc"Symbols that appear in different places in different languages should be listed in language specific topic sections.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded