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

Add docs for mir::BasicBlock #76715

Closed
camelid opened this issue Sep 14, 2020 · 5 comments · Fixed by #76732
Closed

Add docs for mir::BasicBlock #76715

camelid opened this issue Sep 14, 2020 · 5 comments · Fixed by #76732
Assignees
@camelid
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools A-MIR Area: Mid-level IR (MIR) - https://blog.rust-lang.org/2016/04/19/MIR.html C-enhancement Category: An issue proposing an enhancement or a PR with one. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.

Comments

@camelid
Copy link
Member

camelid commented Sep 14, 2020 •
edited by rustbot
Loading

@rustbot modify labels: A-mir T-doc C-enhancement E-easy
@rustbot rustbot added A-MIR Area: Mid-level IR (MIR) - https://blog.rust-lang.org/2016/04/19/MIR.html C-enhancement Category: An issue proposing an enhancement or a PR with one. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools labels Sep 14, 2020
@camelid
Copy link
Member Author

camelid commented Sep 14, 2020

I would be interested in doing this :)

@rustbot claim

@jyn514
Copy link
Member

jyn514 commented Sep 14, 2020 •
edited
Loading

Should this issue be on rustc-dev-guide?

@camelid
Copy link
Member Author

camelid commented Sep 14, 2020

I'm not sure if it's covered there, but I meant in terms of a doc comment on the struct.

@jyn514
Copy link
Member

jyn514 commented Sep 14, 2020

Ok, take a look around https://rustc-dev-guide.rust-lang.org/mir/index.html?highlight=basicblock#mir-data-types then. But you might want to discuss around Zulip what the convention is for doc-comments.

@camelid
Copy link
Member Author

camelid commented Sep 15, 2020

Hmm, I think most of the items in MIR have doc comments. I can ask on Zulip though.

@camelid camelid mentioned this issue Sep 15, 2020
Merged
RalfJung added a commit to RalfJung/rust that referenced this issue Sep 20, 2020
@RalfJung
Rollup merge of rust-lang#76732 - camelid:mir-basic-block-docs, r=Ral…
332b43f 
…fJung

Add docs for `BasicBlock`

Fixes rust-lang#76715.

---

@rustbot modify labels: A-mir T-doc C-enhancement
@bors bors closed this as completed in 39b9a25 Sep 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@camelid camelid

Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools A-MIR Area: Mid-level IR (MIR) - https://blog.rust-lang.org/2016/04/19/MIR.html C-enhancement Category: An issue proposing an enhancement or a PR with one. 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.

Add docs for BasicBlock camelid/rust
3 participants
@jyn514 @camelid @rustbot