-
-
Notifications
You must be signed in to change notification settings - Fork 14.9k
API Docs: process #29370
Copy link
Copy link
Closed
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCCategory: An issue tracking the progress of sth. like the implementation of an RFCE-help-wantedCall for participation: Help is requested to fix this issue.Call for participation: Help is requested to fix this issue.E-mediumCall for participation: Medium difficulty. Experience needed to fix: Intermediate.Call for participation: Medium difficulty. Experience needed to fix: Intermediate.E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.P-mediumMedium priorityMedium priority
Metadata
Metadata
Assignees
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCCategory: An issue tracking the progress of sth. like the implementation of an RFCE-help-wantedCall for participation: Help is requested to fix this issue.Call for participation: Help is requested to fix this issue.E-mediumCall for participation: Medium difficulty. Experience needed to fix: Intermediate.Call for participation: Medium difficulty. Experience needed to fix: Intermediate.E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.P-mediumMedium priorityMedium priority
Type
Fields
Give feedbackNo fields configured for issues without a type.
Part of #29329
http://doc.rust-lang.org/std/process/
Here's what needs to be done to close out this issue:
abortneeds an example, preferably showing off its destuctor behavior. (some elaboration here, and a first PR here)abortshould also talk about its relationship withpanic!, specifically, unwinding vs aborting panics.aborthas a bug:The [abort] function terminates the process, the[]s need to be dropped.ChildtheNoteshouldn't be one, and should come before the examples.ChildStderrshould have its second sentence as not a summary, needs some newlines.ChildStdinhas the same issue.ChildStdouthas the same issue.Commandis good but many of its methods could use more elaboration in their docs. See below for some details.ExitStatusshould link tostatus, and itscodemethod needs an example.Outputshould link tooutput.Stdioshould link tostdioand needs expanded explanations and examples.exitneeds some examples to show its behavior. An example of how people use this inmainwould be fantastic too.With regards to
Command, @frewsxcv brought up in #40983 thatstdin,stdout, andstderrshould specify what the default behavior is if they aren't explicitly called.And @retep998 mentions