docs: applications and authorization #5477
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
mtojek
changed the title
mafredri
reviewed
Dec 21, 2022
There was a problem hiding this comment.
- What quality level of documentation do we want to achieve? (description:
nonevs.DisplayName is the displayed name)
Instead of none, we could omit the text entirely (empty). I think it's fine not to document all obvious things for now. But ultimately I'd like for us to have very good coverage in codersdk/API docs with explanations for most fields.
|
Thanks for the review, @mafredri! All comments addressed. It's interesting that we can continuously improve the rendering procedure to achieve better results! |
mafredri
approved these changes
Dec 21, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Related: #3522
Changes:
Applications,Authorization@Description)@Consumewith@AcceptQuestion:
* What quality level of documentation do we want to achieve? (description:Fix:nonevs.DisplayName is the displayed name)s/none//g