Skip to content

It is hard to distinguish between functions in Rustdoc style using the new RFC style #42988

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
Closed
shepmaster opened this issue Jun 30, 2017 · 4 comments
Closed

It is hard to distinguish between functions in Rustdoc style using the new RFC style #42988

shepmaster opened this issue Jun 30, 2017 · 4 comments
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@shepmaster
Copy link
Member

shepmaster commented Jun 30, 2017 •
edited
Loading

Looking at the docs for trust-dns' 0.10.4 trust_dns::client::Client:

image

All of the function headers kind of run together and it's hard to determine where they stop. Perhaps the "fix" is just to add a bit of spacing between them.
@shepmaster shepmaster added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jun 30, 2017
@retep998
Copy link
Member

Why is there a space between get_client_handle and query and not between the other functions? I'm in favor of simply adding some space between the function definitions.

@shepmaster
Copy link
Member Author

space between get_client_handle and query

I assume that there's a division between required methods and provided methods. FWIW, I think that differentiating between them is useful in the general sense.

@PlasmaPower
Copy link
Contributor

Do we want a full newline between long functions or just a bit of space? Looking at the generated HTML, just a bit of space might be hard since each function doesn't have its own tag. We can change that of course.

@GuillaumeGomez
Copy link
Member

I'm on it.

@GuillaumeGomez GuillaumeGomez mentioned this issue Jul 8, 2017
Merged
bors added a commit that referenced this issue Jul 9, 2017
@bors
Auto merge of #43130 - GuillaumeGomez:rustdoc-fn-spacing, r=QuietMisd…
8b1271f 
…reavus

Add spacing between trait functions

Fixes #42988.

<img width="1440" alt="screen shot 2017-07-09 at 17 02 16" src="https://user-images.githubusercontent.com/3050060/27995068-672a3208-64c8-11e7-9bc7-c7288f2cd27b.png">
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
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
4 participants
@shepmaster @retep998 @GuillaumeGomez @PlasmaPower