Fix the documentation link to point to Perceptible protocol inside PerceptionCore
#121
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
…`PerceptionCore`
mbrandonw
reviewed
Jan 30, 2025
README.md
Outdated
| @@ -121,4 +121,4 @@ This library is released under the MIT license. See [LICENSE](LICENSE) for detai | |||
| [pointfreeco]: https://www.pointfree.co | |||
| [mbrandonw]: https://twitter.com/mbrandonw | |||
| [stephencelis]: https://twitter.com/stephencelis | |||
| [docs]: https://swiftpackageindex.com/pointfreeco/swift-perception/main/documentation/perception | |||
| [docs]: https://swiftpackageindex.com/pointfreeco/swift-perception/main/documentation/perceptioncore/perceptible | |||
There was a problem hiding this comment.
Instead of this change we can tell SPI to default to PerceptionCore when one visits the docs for this library. You can do so by flipping the order of these elements:
Line 4 in 9e9ec51
|
@mbrandonw Done :) |
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.
The documentation link was originally pointing to the
Perceptionmodule. However, it would be better if it were adjusted to point toPerceptionCore.