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

x/pkgsite: deprecated UI is overly repetitive #48678

Closed
mvdan opened this issue Sep 29, 2021 · 4 comments
Closed

x/pkgsite: deprecated UI is overly repetitive #48678

mvdan opened this issue Sep 29, 2021 · 4 comments

Comments

@mvdan
Copy link
Member

@mvdan mvdan commented Sep 29, 2021

Take a look at https://pkg.go.dev/path/filepath#HasPrefix:

image

I see deprecated as many as three times: next to the declaration in the form of a label, in the "This function has been deprecated." notice below, and in the "Deprecated:" text in the original godoc.

I get that the label should be there, to still be clear when one presses "hide". And that the "Deprecated:" text is part of the original godoc, so we should probably not alter the text.

That leaves me with the extra notice in between, which I think doesn't add much information. Here's an example of how it looks like when we remove that extra notice - in my opinion, better:

image

cc @julieqiu

@mvdan mvdan added the pkgsite label Sep 29, 2021
@gopherbot gopherbot added this to the Unreleased milestone Sep 29, 2021
@julieqiu
Copy link
Contributor

@julieqiu julieqiu commented Sep 29, 2021

That makes sense to me.

/cc @jinhongy @fflewddur @jamalc for input

@julieqiu julieqiu removed this from the Unreleased milestone Sep 29, 2021
@julieqiu julieqiu added this to the pkgsite/frontend milestone Sep 29, 2021
@julieqiu julieqiu added the UX label Sep 29, 2021
@mvdan
Copy link
Member Author

@mvdan mvdan commented Sep 29, 2021

It's also perhaps amusing that HasPrefix is named four times, but I don't think we can blame that on the deprecation UI. The rest of the UI already consistently repeats each name twice, and the godoc as-is has the name two more times.

@mibk
Copy link
Contributor

@mibk mibk commented Sep 30, 2021

I would also suggest putting the "Deprecated:" prefix in bold to highlight its importance.

@gopherbot
Copy link

@gopherbot gopherbot commented Oct 11, 2021

Change https://golang.org/cl/355189 mentions this issue: static/doc: less repetative deprecation UI

@gopherbot gopherbot closed this in 87f5a1b Oct 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants