feat(internal/godocfx): mark status of deprecated items #4525
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
google-cla
bot
added
the
cla: yes
noahdietz
approved these changes
Aug 2, 2021
dandhlee
approved these changes
Aug 2, 2021
| // getStatus returns a possibly empty status string for the given | ||
| // docs. | ||
| func getStatus(doc string) string { | ||
| deprecated := "\nDeprecated:" |
There was a problem hiding this comment.
Would it always work with a newline prefix? Is it possible that it's embedded within a line and only has a whitespace prefix instead?
There was a problem hiding this comment.
We may even be able to strengthen this to be two newlines before, but I think this is fine. See https://github.com/golang/go/wiki/Deprecated.
tbpg
commented
Aug 2, 2021
| // getStatus returns a possibly empty status string for the given | ||
| // docs. | ||
| func getStatus(doc string) string { | ||
| deprecated := "\nDeprecated:" |
There was a problem hiding this comment.
We may even be able to strengthen this to be two newlines before, but I think this is fine. See https://github.com/golang/go/wiki/Deprecated.
tbpg
added
the
automerge
broady
approved these changes
Aug 2, 2021
gcf-merge-on-green
bot
removed
the
automerge
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.
A separate PR will update the template to use this new field.
A future PR here may include a
statusfor the overall package and in the TOC.