Rephrase auth trait documentation #2051
Merged
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
This rephrases the documentation for auth traits to read more like documentation for the auth type rather than documentation for a function. This allows it to be more naturally used in documentation generation without change. This also adds inline links to external documentation rather than solely relying on the external docs trait. While that trait is useful still, rendered docs are more natural if there's inline links too.
mtdowling
approved these changes
Nov 24, 2023
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.
This rephrases the documentation for auth traits to read more like documentation for the auth type rather than documentation for a function. This allows it to be more naturally used in documentation generation without change. This also adds inline links to external documentation rather than solely relying on the external docs trait. While that trait is useful still, rendered docs are more natural if there's inline links too.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.