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.

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

Add rust-analyzer usage to documentation #649

Closed
wants to merge 1 commit into from

Conversation

yagehu
Copy link

@yagehu yagehu commented Mar 27, 2021

This commit adds the instructions for setting up rust-analyzer support
to the main documentation landing page. The instructions were originally
given in #505.

This commit adds the instructions for setting up rust-analyzer support
to the main documentation landing page. The instructions were originally
given in bazelbuild#505.
@UebelAndre
Copy link
Collaborator

Thanks for the PR! Before digging into this, just wanted to get some thoughts on whether or not we should use the doc attribute from the rust_analyzer_aspect rule. This would closer tie the documentation to the implementing code. I definitely think rust_analyzer should be called out on the first page but am wondering if the bulk of the docs should live with the rules

rust_analyzer_aspect = aspect(
attr_aspects = ["deps", "proc_macro_deps"],
implementation = _rust_analyzer_aspect_impl,
toolchains = [str(Label("//rust:toolchain"))],
incompatible_use_toolchain_transition = True,
doc = "Annotates rust rules with RustAnalyzerInfo later used to build a rust-project.json",
)

@google-cla
Copy link

google-cla bot commented Apr 8, 2021

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

@google-cla google-cla bot added cla: no and removed cla: yes labels Apr 8, 2021
@UebelAndre
Copy link
Collaborator

Hey, sorry about the commit that was added to this PR. I'd love to see documentation for rust analyzer go in but you'll have to drop that commit first 😅

@google-cla
Copy link

google-cla bot commented Apr 23, 2021

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

@google-cla
Copy link

google-cla bot commented Apr 23, 2021

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

@yagehu
Copy link
Author

yagehu commented Apr 23, 2021

Hey, sorry about the commit that was added to this PR. I'd love to see documentation for rust analyzer go in but you'll have to drop that commit first sweat_smile

Dropped the commit. Sorry for the delay.

@UebelAndre
Copy link
Collaborator

Hey @yagehu, I ended up using your changes here in #711 for the rust-analyzer section. I wanted to thank you again and apologize for "stealing your thunder" 😅

Gonna close this for now since virtually all the changes here are already merged

@UebelAndre UebelAndre closed this Apr 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants