Skip to content

Add docs for mir::BasicBlock #76715

Closed
@camelid

Description

@camelid
Member

@rustbot modify labels: A-mir T-doc C-enhancement E-easy

Activity

added
A-MIRArea: Mid-level IR (MIR) - https://blog.rust-lang.org/2016/04/19/MIR.html
C-enhancementCategory: An issue proposing an enhancement or a PR with one.
E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
on Sep 14, 2020
camelid

camelid commented on Sep 14, 2020

@camelid
MemberAuthor

I would be interested in doing this :)

@rustbot claim

jyn514

jyn514 commented on Sep 14, 2020

@jyn514
Member

Should this issue be on rustc-dev-guide?

camelid

camelid commented on Sep 14, 2020

@camelid
MemberAuthor

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

jyn514

jyn514 commented on Sep 14, 2020

@jyn514
Member

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

camelid commented on Sep 15, 2020

@camelid
MemberAuthor

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

added 2 commits that reference this issue on Sep 20, 2020

Rollup merge of rust-lang#76732 - camelid:mir-basic-block-docs, r=Ral…

332b43f

Rollup merge of rust-lang#76732 - camelid:mir-basic-block-docs, r=Ral…

39b9a25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

A-MIRArea: Mid-level IR (MIR) - https://blog.rust-lang.org/2016/04/19/MIR.htmlA-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-enhancementCategory: An issue proposing an enhancement or a PR with one.E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Development

    Participants

    @jyn514@camelid@rustbot

    Issue actions

      Add docs for `mir::BasicBlock` · Issue #76715 · rust-lang/rust