-
Notifications
You must be signed in to change notification settings - Fork 0
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
Clean up doc comments and add periods #43
base: main
Are you sure you want to change the base?
Conversation
This commit adds periods to all of the comments in the cir and engine. This commit also unifies all of the types in the cir to make it easier to interact with those types.
/// | ||
/// # Arguments | ||
/// * `children` - Collection of child items to convert | ||
/// A generic function that converts children with type `S` into a `Arc<T>`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I prefer the old comment here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the eg. of what S and T can be is helpful
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In general I dislike comments that explain the function signature essentially verbatim, they don't really add anything in helping someone understand why this function is here and ends up cluttering headspace.
7e176c5
to
0f36b12
Compare
Problem
Cleans up a bit of the CPS PR.
Summary of changes
This commit adds periods to all of the comments in the cir and engine. I also added some more detail here and there.
This commit also unifies all of the types in the cir to make it easier to interact with those types. Imo it makes more sense to have them all in one place rather than to have to figure out the paths to each of them every time you import.