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.

Sign up for GitHub

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

Jump to bottom

Rustdoc renders associated constants poorly #44348

Closed
sgrif opened this issue Sep 5, 2017 · 5 comments
Closed

Rustdoc renders associated constants poorly #44348

sgrif opened this issue Sep 5, 2017 · 5 comments
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@sgrif
Copy link
Contributor

sgrif commented Sep 5, 2017 •
edited
Loading

We recently changed Diesel to use associated constants in a few places, and noticed that our docs look a lot worse as a result.

screen shot 2017-09-05 at 1 12 41 pm

It stands out far too much, and looks nothing like any other section of the docs related to traits. It'd be great if the definition could be inlined and look the same as it does for associated types.
@killercup
Copy link
Member

FTR, original implementation was in #39944 and current design suggested in #39944 (comment)

@alexcrichton alexcrichton added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. C-enhancement Category: An issue proposing an enhancement or a PR with one. T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. labels Sep 7, 2017
@GuillaumeGomez
Copy link
Member

Seems like it has been fixed by #39944 so I close.

@sgrif
Copy link
Contributor Author

sgrif commented Dec 6, 2017

@GuillaumeGomez That was the pull request that introduced this bug, not the one that fixed it. Please re-open this issue.

@GuillaumeGomez GuillaumeGomez reopened this Dec 6, 2017
@nox
Copy link
Contributor

nox commented Aug 15, 2018

Why are definitions of constants even printed? This leaks implementation details about how opaque wrappers etc are defined. Could we instead display them only if --document-private-items is on?

@GuillaumeGomez GuillaumeGomez mentioned this issue Aug 15, 2018
Merged
@pravic pravic mentioned this issue Sep 7, 2018
Closed
bors added a commit that referenced this issue Sep 12, 2018
@bors
Auto merge of #53409 - GuillaumeGomez:associated-const-value, r=Quiet…
f2302da 
…Misdreavus

Don't show associated const value anymore

Part of #44348.

Before:

<img width="1440" alt="screen shot 2018-08-16 at 00 48 30" src="https://user-images.githubusercontent.com/3050060/44177414-20ef1480-a0ee-11e8-80d4-7caf082cf0de.png">

After:

<img width="1440" alt="screen shot 2018-08-16 at 00 48 23" src="https://user-images.githubusercontent.com/3050060/44177417-251b3200-a0ee-11e8-956a-4229275e3342.png">

cc @nox

r? @QuietMisdreavus
@QuietMisdreavus QuietMisdreavus mentioned this issue Nov 4, 2018
Closed
@ollie27
Copy link
Member

ollie27 commented Nov 22, 2019

I think we can consider this fixed by #53409.

@ollie27 ollie27 closed this as completed Nov 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@killercup @alexcrichton @nox @sgrif @GuillaumeGomez @ollie27