Don't enforce unique filenames for documentation extensions #863
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
Since documentation extensions' filenames have no impact on the URL of any pages, there's no need to enforce unique filenames for them. DocC currently uses only the filename / last path component of articles to determine if there is a duplicate article. This change excludes doc extensions from that check to allow documentation extensions to have the same filename. rdar://117174884
Checks that doc extensions with the same filename do not produce a warning and DocC no longer drops the content from one of the files.
mayaepps
commented
Mar 22, 2024
| // Separate articles that look like documentation extension files from other articles, so that the documentation extension files can be matched up with a symbol. | ||
| // At this point we consider all articles with an H1 containing link "documentation extension" - some links might not resolve in the final documentation hierarchy | ||
| // and we will emit warnings for those later on when we finalize the bundle discovery phase. | ||
| if result.value.title?.child(at: 0) is AnyLink { |
There was a problem hiding this comment.
From what I can tell, isDocumentationExtension ((analyzed as? Article)?.title?.child(at: 0) is AnyLink) should be equivalent to result.value.title?.child(at: 0) is AnyLink, so this change hopefully improves readability, but I'd appreciate an extra pair of eyes to be sure I'm not missing something.
There was a problem hiding this comment.
Yep - we check a few lines above that if let article = analyzed as? Article, so we know that the analyzed node is an Article, and also therefore a Semantic. SemanticResult is just a simple struct holding the article as value and a couple other values. So we know that result.value is just article which is just analyzed as? Article.
The rest of the expression is the same, so yea your simplification is good I think 👍
|
@swift-ci Please test |
mayaepps
added a commit
to mayaepps/swift-docc
that referenced
this pull request
Mar 25, 2024
…g#863) * Allow documentation extensions to have the same name Since documentation extensions' filenames have no impact on the URL of any pages, there's no need to enforce unique filenames for them. DocC currently uses only the filename / last path component of articles to determine if there is a duplicate article. This change excludes doc extensions from that check to allow documentation extensions to have the same filename. rdar://117174884 * Add test to ensure doc extensions can have the same filename Checks that doc extensions with the same filename do not produce a warning and DocC no longer drops the content from one of the files.
mayaepps
added a commit
that referenced
this pull request
Mar 26, 2024
) * Allow documentation extensions to have the same name Since documentation extensions' filenames have no impact on the URL of any pages, there's no need to enforce unique filenames for them. DocC currently uses only the filename / last path component of articles to determine if there is a duplicate article. This change excludes doc extensions from that check to allow documentation extensions to have the same filename. rdar://117174884 * Add test to ensure doc extensions can have the same filename Checks that doc extensions with the same filename do not produce a warning and DocC no longer drops the content from one of the files.
emilyychenn
added a commit
to emilyychenn/swift-docc
that referenced
this pull request
Mar 27, 2024
Fix typo in RenderContentCompilerTests resolve some PR feedback Update Sources/SwiftDocC/Model/Rendering/Content/RenderBlockContent.swift Co-authored-by: David Rönnqvist <[email protected]> add tests with multiple variants of thematic breaks Don't enforce unique filenames for documentation extensions (swiftlang#863) * Allow documentation extensions to have the same name Since documentation extensions' filenames have no impact on the URL of any pages, there's no need to enforce unique filenames for them. DocC currently uses only the filename / last path component of articles to determine if there is a duplicate article. This change excludes doc extensions from that check to allow documentation extensions to have the same filename. rdar://117174884 * Add test to ensure doc extensions can have the same filename Checks that doc extensions with the same filename do not produce a warning and DocC no longer drops the content from one of the files. Update the year in license headers Bump patch version
emilyychenn
added a commit
to emilyychenn/swift-docc
that referenced
this pull request
Mar 27, 2024
Fix typo in RenderContentCompilerTests resolve some PR feedback Update Sources/SwiftDocC/Model/Rendering/Content/RenderBlockContent.swift Co-authored-by: David Rönnqvist <[email protected]> add tests with multiple variants of thematic breaks Don't enforce unique filenames for documentation extensions (swiftlang#863) * Allow documentation extensions to have the same name Since documentation extensions' filenames have no impact on the URL of any pages, there's no need to enforce unique filenames for them. DocC currently uses only the filename / last path component of articles to determine if there is a duplicate article. This change excludes doc extensions from that check to allow documentation extensions to have the same filename. rdar://117174884 * Add test to ensure doc extensions can have the same filename Checks that doc extensions with the same filename do not produce a warning and DocC no longer drops the content from one of the files. Update the year in license headers Bump patch version
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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://117174884
Summary
Currently, if any two articles have the same filename, DocC will warn for one of the files that it is a redeclaration and the file will be skipped. Article filenames need to be unique because those base names are used for the article's URL which need to be unique. However, documentation extensions' filenames have no impact on the URLs of any pages, so there's no need to enforce unique filenames for them.
This change skips the enforcement of unique filenames for documentation extensions to allow doc extensions to have the same filenames and for a doc extension to have the same filename as an article.
Testing
Steps:
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded