Use link text in docs to omit Self:: prefix in rendered docs
#561
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
Ralith
approved these changes
Jan 24, 2022
That's my general preference, subject to developer patience. |
Suggestion from [#559]. [#559]: #559 (comment)
MarijnS95
force-pushed
the
docs-omit-self
branch
from
1cb5ece to
83daaaf
Compare
MarijnS95
changed the title
ColorComponentFlags docs to omit Self::Self:: prefix in rendered docs
|
@Ralith Consider it regexed :) |
MarijnS95
commented
Jan 24, 2022
| @@ -264,10 +264,10 @@ impl Entry { | |||
| &self.entry_fn_1_1 | |||
| } | |||
|
|
|||
| #[deprecated = "This function is unavailable and therefore panics on Vulkan 1.0, please use `try_enumerate_instance_version` instead"] | |||
| #[deprecated = "This function is unavailable and therefore panics on Vulkan 1.0, please use `try_enumerate_instance_version()` instead"] | |||
There was a problem hiding this comment.
I thought (intradoc) links were also possible in deprecation blocks (similar to other markdown), but nope :(
There was a problem hiding this comment.
Aw, that seems like a really useful place for them too. Feature request upstream?
There was a problem hiding this comment.
Heh feature requests have to go to the "internals" forum, I'll see what I can do.
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.
Suggestion from #559.
Note thatSelf::in_len()function docs hasn't been replaced (yet?) as the longer function names make this format rather verbose. However, we should probably prefer docs readability over code readability?