Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(internal/godocfx): mark status of deprecated items #4525

Merged
merged 3 commits into from
Aug 2, 2021

Conversation

tbpg
Copy link
Contributor

@tbpg tbpg commented Jul 30, 2021

A separate PR will update the template to use this new field.

A future PR here may include a status for the overall package and in the TOC.

@tbpg tbpg requested a review from a team as a code owner July 30, 2021 18:29
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Jul 30, 2021
@tbpg tbpg requested a review from noahdietz August 2, 2021 13:31
Copy link

@dandhlee dandhlee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, one minor concern below.

// getStatus returns a possibly empty status string for the given
// docs.
func getStatus(doc string) string {
deprecated := "\nDeprecated:"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

@tbpg tbpg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

// getStatus returns a possibly empty status string for the given
// docs.
func getStatus(doc string) string {
deprecated := "\nDeprecated:"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 tbpg added the automerge Merge the pull request once unit tests and other checks pass. label Aug 2, 2021
@tbpg tbpg requested a review from broady August 2, 2021 16:55
@gcf-merge-on-green gcf-merge-on-green bot merged commit d571c6f into master Aug 2, 2021
@gcf-merge-on-green gcf-merge-on-green bot deleted the godocfx-status branch August 2, 2021 20:24
@gcf-merge-on-green gcf-merge-on-green bot removed the automerge Merge the pull request once unit tests and other checks pass. label Aug 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants