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 some docs on the Process object #190

Merged
merged 1 commit into from
Jul 26, 2022
Merged

Add some docs on the Process object #190

merged 1 commit into from
Jul 26, 2022

Conversation

eminence
Copy link
Owner

CC #188

@eminence
Copy link
Owner Author

If you have time for a quick review @obaudys, I'd be grateful.

Copy link

@obaudys obaudys 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 to me; it neatly spells out what is going on and why.

You seem to have closed the impl block and then reopened it:

}

impl Process {

Is there any reason for that? Asking as a rust newbie.

@eminence
Copy link
Owner Author

It's subtle, but I added some docs to the impl block on line 779. This isn't all that well known (and honestly not used that often), but you can add documentation to the impl block itself, as in:

/// This is some docs
impl Foo {
    /// Create a new thing
    pub fn new() -> Self { todo!() }
}

@eminence eminence merged commit f54530e into master Jul 26, 2022
@eminence eminence deleted the docs branch August 21, 2022 00:01
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