Skip to content

Inlined trait docs don't include method argument names #14670

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
tomjakubowski opened this issue Jun 5, 2014 · 0 comments
Closed

Inlined trait docs don't include method argument names #14670

tomjakubowski opened this issue Jun 5, 2014 · 0 comments
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@tomjakubowski
Copy link
Contributor

This is somewhat jarring when the documentation references argument names. A motivating example is in the StrSlice docs:

fn slice(&self, uint, uint) -> &'a str
Returns a slice of the given string from the byte range [begin..end).

Related: #14346
@huonw huonw added the A-rustdoc label Jun 5, 2014
alexcrichton added a commit to alexcrichton/rust that referenced this issue Jun 5, 2014
@alexcrichton
rustc: Encode argument names for traits
234bb25 
This ensures that rustdoc can properly document inlined traits across crates.

Closes rust-lang#14670
@alexcrichton alexcrichton mentioned this issue Jun 5, 2014
Closed
mcpherrinm pushed a commit to mcpherrinm/rust that referenced this issue Jun 10, 2014
@alexcrichton @mcpherrinm
rustc: Encode argument names for traits
30a40c7 
This ensures that rustdoc can properly document inlined traits across crates.

Closes rust-lang#14670
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

Successfully merging a pull request may close this issue.

rustc: Encode argument names for traits alexcrichton/rust
2 participants
@tomjakubowski @huonw