Fix README link #3447
Merged
Fix README link #3447
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
armanbilge
reviewed
Jun 14, 2024
README.md
Outdated
| @@ -33,7 +33,7 @@ Quick links: | |||
|
|
|||
| ### <a id="docs"></a>Documentation and getting help ### | |||
|
|
|||
| * There are Scaladoc API documentations for [the core library][core-api], which defines and implements the core types for streams and pulls, as well as the type aliases for pipes and sinks. [The `io` library][io-api] provides FS2 bindings for NIO-based file I/O and TCP/UDP networking. | |||
| * There are Scaladoc API documentations for [the core library][api], which defines and implements the core types for streams and pulls, as well as the type aliases for pipes and sinks. [The `io` library][io-api] provides FS2 bindings for NIO-based file I/O and TCP/UDP networking. | |||
There was a problem hiding this comment.
Actually the API docs are no longer split into core/io, it's all under the [api] link now. I suspect the second link is also broken.
There was a problem hiding this comment.
I have removed reference to that split. I made the phrasing of this bullet point similar to the one after it. Please let me know if you have other preferences/suggestions on wording.
There was a problem hiding this comment.
As there remained no references to [io-api] or to [rx-api], I removed the Sonatype links to both.
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 README currently contains "There are Scaladoc API documentations for [the core library][core-api], which defines and..."; note that a link has not been rendered to "[core-api]".
Looking through git blame, "core-api" previously existed (relevant commit) and pointed to a link on sonatype.org. The reference "[core-api]" changed to "[api]" in this commit but one reference to "core-api" was not updated.