Skip to content

librustc_borrowck/borrowck/doc.rs doesn't get rendered #21281

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
kmcallister opened this issue Jan 17, 2015 · 5 comments · Fixed by #22126
Closed

librustc_borrowck/borrowck/doc.rs doesn't get rendered #21281

kmcallister opened this issue Jan 17, 2015 · 5 comments · Fixed by #22126
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.

Comments

@kmcallister
Copy link
Contributor

Because mod borrowck is private.
@kmcallister kmcallister added A-docs E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. labels Jan 17, 2015
@steveklabnik
Copy link
Member

/cc @nikomatsakis , this has always been weird

@nikomatsakis
Copy link
Contributor

I think the consensus was that we should add some way to include .md files in rustdoc?

I personally think long-form documentation is super useful, so I wouldn't want to remove it from the repo, but I'd love to make a proper markdown file and not a big comment.

@steveklabnik
Copy link
Member

Rustdoc already knows how to do .md files, so that wasn't the problem. I think it was that you liked the abilty to search or something?

@steveklabnik
Copy link
Member

Regardless, I thought you didn't want them to be markdown files, so if you do, then woooo 🎊

@kmcallister
Copy link
Contributor Author

Maybe we need a "scary compiler internals" section of the book.

Actually, I read through the borrowchecker doc.rs the other day and it was fairly comprehensible. It definitely improved my understanding of Rust and not just of the implementation.

@steveklabnik steveklabnik mentioned this issue Feb 10, 2015
Merged
steveklabnik added a commit to steveklabnik/rust that referenced this issue Feb 11, 2015
@steveklabnik
Move rustc docs to the book
005a250 
This is super black magic internals at the moment, but having it
somewhere semi-public seems good. The current versions weren't being
rendered, and they'll be useful for some people.

Fixes rust-lang#21281
bors added a commit that referenced this issue Feb 15, 2015
@bors
Auto merge of #22126 - steveklabnik:gh21281, r=nikomatsakis
b6d91a2 
This is super black magic internals at the moment, but having it
somewhere semi-public seems good. The current versions weren't being
rendered, and they'll be useful for some people.

Fixes #21281

r? @nikomatsakis @kmcallister
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Move rustc docs to the book steveklabnik/rust
3 participants
@steveklabnik @nikomatsakis @kmcallister