Skip to content

Lifetime generics are being omitted in rustdoc output #16228

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

Closed
chris-morgan opened this issue Aug 3, 2014 · 4 comments
Closed

Lifetime generics are being omitted in rustdoc output #16228

chris-morgan opened this issue Aug 3, 2014 · 4 comments
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@chris-morgan
Copy link
Member

IndexMut docs:

pub trait IndexMut<Index, Result> {
    fn index_mut(&'a mut self, index: &Index) -> &'a mut Result;
}

But this is what the code says:

pub trait IndexMut<Index, Result> {
    fn index_mut<'a>(&'a mut self, index: &Index) -> &'a mut Result;
}

What happened to the <'a>? We need it for clarity!

@steveklabnik
Copy link
Member

These aren't 'generics', but yeah, this is a bug for sure.

@chris-morgan
Copy link
Member Author

They may not be 'generics' (whatever you mean by that) but they are generics—just generic lifetime parameters rather than generic type parameters.

@sfackler
Copy link
Member

sfackler commented Aug 3, 2014

Dup of #14462

@sfackler sfackler closed this as completed Aug 3, 2014
@chris-morgan
Copy link
Member Author

Dunno quite how I managed to miss that one…

lnicola pushed a commit to lnicola/rust that referenced this issue Jan 3, 2024
minor: Add some more crates to architecture.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

3 participants