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 does not document borrowck::doc #11443

Closed
brson opened this issue Jan 10, 2014 · 3 comments
Closed

rustdoc does not document borrowck::doc #11443

brson opened this issue Jan 10, 2014 · 3 comments
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@brson
Copy link
Contributor

brson commented Jan 10, 2014

Not sure why: http://static.rust-lang.org/doc/master/rustc/middle/borrowck/index.html
@huonw
Copy link
Member

huonw commented Jan 10, 2014

I think rustdoc doesn't render modules with no items.

@adrientetar
Copy link
Contributor

Why is borrowck doc on an individual file? It seems weird to have a file for documentation alone.

@huonw
Copy link
Member

huonw commented Jan 10, 2014

It's basically a description of the borrow checking algorithm, and so it's long (1000 lines, one comment block), and having such a document inline at the top of a normal file along with normal code is annoying for people using/manipulating that file (most importantly, the author & maintainer of that portion of the code and documentation (@nikomatsakis) doesn't like it).

(There are two other similar modules, middle/typeck/infer/doc.rs and middle/typeck/infer/region_inference/doc.rs, for the same reason.)

flip1995 pushed a commit to flip1995/rust that referenced this issue May 17, 2024
@bors
Auto merge of rust-lang#11540 - J-ZhengLi:issue11443, r=xFrednet
7cfb9a0 
add new lint that disallow renaming parameters in trait functions

fixes: rust-lang#11443
fixes: rust-lang#486

changelog: add new lint [`renamed_function_params`]

Note that the lint name is not final, because I have a bad reputation in naming things, and I don't trust myself.
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
3 participants
@brson @huonw @adrientetar