Fix broken links in derive macro docs #1292
Merged
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
They are working just find, no need to ignore them.
Previous links worked locally for both scylla and scylla-cql, but on docs.rs they only worked for scylla-cql. This is because on docs.rs you have only docs for a single crate, so we can't refer to scylla-cql from scylla. Fortunately we don't need to refer to it, because scylla re-export all of those items.
|
|
wprzytula
approved these changes
Mar 24, 2025
muzarski
approved these changes
Mar 24, 2025
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.
Fixes #1281
This PR fixes the links that are broken when rendering docs on docs.rs.
Additionally, I made code blocks in derive macros docs non-ignore - they are fully correct so I don't see the point of ignoring them.
Pre-review checklist
I added relevant tests for new features and bug fixes.I have provided docstrings for the public items that I want to introduce.I have adjusted the documentation in./docs/source/.Fixes:annotations to PR description.