This repository has been archived by the owner on Jun 1, 2023. It is now read-only.
Fix toplevel symbols #260
Merged
Fix toplevel symbols #260
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
|
That's totally on me. I introduced this regression by making an unrelated change to Thank you for identifying this and adding test coverage. I think better and more extensive testability — especially around what gets built would be valuable. That was one of my goals for #67, but that got away from me in my first few attempts. I'd like to try again after 1.0.0. As for this, I'm going to apply a hot fix and retag the existing release. |
mattt
reviewed
Apr 26, 2021
Lukas-Stuehrk
commented
Apr 26, 2021
mattt
reviewed
Apr 26, 2021
mattt
approved these changes
Apr 26, 2021
mattt
added a commit
that referenced
this pull request
Apr 26, 2021
* Add failing tests for top level symbols. * Fix top level symbols. * Update Sources/SwiftDoc/Interface.swift * Remove print statement Co-authored-by: Mattt <mattt@me.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Looks like my assessment was wrong and we introduced a regression in #230.
There's a logic error when checking which symbols are considered top-level symbols. The path of a symbol's identifier always contains the symbol's own name. Because of this,
swift-docversion1.0.0-beta.6is not including all top level symbols which are not structs or classes.This change fixes that regression and adds some tests.
I think we should add some regression tests at some point to check which symbols are included in a generated documentation.