Skip to content

Add comments explaining each dependency #122

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

Merged
merged 1 commit into from
Apr 28, 2022
Merged

Add comments explaining each dependency #122

merged 1 commit into from
Apr 28, 2022

Conversation

nnmm
Copy link
Contributor

@nnmm nnmm commented Apr 22, 2022

@nnmm nnmm requested a review from jhdcs April 22, 2022 22:20
Copy link
Collaborator

@jhdcs jhdcs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, but should there be comments for the examples crate as well? To fully document everything going on for ROS 2 users not used to Rust (and vice-versa)? Or would this be repeating ourselves too much?

@nnmm
Copy link
Contributor Author

nnmm commented Apr 26, 2022

Looks good, but should there be comments for the examples crate as well? To fully document everything going on for ROS 2 users not used to Rust (and vice-versa)? Or would this be repeating ourselves too much?

I looked at the rclrs_examples/Cargo.toml but decided not to comment it for now. It's just anyhow + message packages, so there's nothing interesting to say about these, and I also think this convention applies more to libraries than binaries. If you'd like me to, I can add it though.

Copy link
Collaborator

@jhdcs jhdcs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you feel that adding the extra comments will be too confusing/verbose, then I will defer to your judgement. Otherwise, everything looked good to me!

@nnmm nnmm merged commit d191419 into master Apr 28, 2022
@nnmm nnmm deleted the dependency_comments branch April 28, 2022 14:52
@nnmm
Copy link
Contributor Author

nnmm commented Apr 28, 2022

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants