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

crate_universe: Add documentation #691

Closed
UebelAndre opened this issue Apr 17, 2021 · 3 comments
Closed

crate_universe: Add documentation #691

UebelAndre opened this issue Apr 17, 2021 · 3 comments
Assignees
@illicitonion
Labels
external-crates

Comments

@UebelAndre
Copy link
Collaborator

Crate universe needs code documentation so user don't have to jump around multiple times to understand a given variable. The lack of documented code makes contributing to the rule unnecessarily difficult.
@UebelAndre
Copy link
Collaborator Author

The rule attributes should be documented as well.

@UebelAndre
Copy link
Collaborator Author

The attributes were documented in #705 but code documentation is still a bit lacking. Would love to see it improved.

@UebelAndre
Copy link
Collaborator Author

I think there's sufficient documentation in the redesign (cargo-bazel).

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

@illicitonion illicitonion

Labels
external-crates
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@illicitonion @UebelAndre