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

fix: Use the correct deprecated syntax in code #531

Merged
merged 3 commits into from
Apr 6, 2023

Conversation

shogo82148
Copy link
Contributor

The godoc of deprecated types, values and functions should be match the regexp (^|\n\s*\n)\s*Deprecated:.

https://github.com/golang/pkgsite/blob/8996ff632abee854aef1b764ca0501f262f8f523/internal/godoc/dochtml/deprecated.go#L12-L13

pkg.go.dev marks these items deprecated and show them using a special style.

e.g. https://pkg.go.dev/net/http#CloseNotifier

image

Copy link
Member

@lahirumaramba lahirumaramba 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 @shogo82148 ! LGTM

@lahirumaramba lahirumaramba changed the base branch from master to dev March 24, 2023 16:54
@lahirumaramba
Copy link
Member

The base branch needs to be changed to dev. Any chance you could fix that in your shogo82148:mark-deprecated-on-pkgsite branch?

The godoc of deprecated types, values and functions should be match
the regexp `(^|\n\s*\n)\s*Deprecated:`.

https://github.com/golang/pkgsite/blob/8996ff632abee854aef1b764ca0501f262f8f523/internal/godoc/dochtml/deprecated.go#L12-L13

pkg.go.dev marks these items deprecated
and show them using a special style.
@lahirumaramba lahirumaramba changed the title mark deprecated on pkg.go.dev fix: mark deprecated on pkg.go.dev Mar 28, 2023
@lahirumaramba lahirumaramba changed the title fix: mark deprecated on pkg.go.dev fix: Use the correct deprecated syntax in code Mar 28, 2023
Copy link
Member

@lahirumaramba lahirumaramba 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 for your contribution! LGTM!

@lahirumaramba lahirumaramba merged commit ca0bfd9 into firebase:dev Apr 6, 2023
6 checks passed
@shogo82148 shogo82148 deleted the mark-deprecated-on-pkgsite branch April 26, 2023 00:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants