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

Update scaladoc for Process #3381

Merged
merged 2 commits into from
Jan 23, 2024
Merged

Update scaladoc for Process #3381

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
037e8b9
Fix link in contributing doc
daddykotex Jan 22, 2024
2900001
Update scaladoc for Process
daddykotex Jan 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ If at any point you run into problems, you can always ask a question on [the fs2

## How to submit a change

If you see something worth adding, make the relevant changes in a fork of the source code and [submit a pull request to the project](fs2-pulls). If you don't know what you could help with, take a look at [the issues marked as "help wanted"][low-hanging-fruit] or ask on [Discord][fs2-dev].
If you see something worth adding, make the relevant changes in a fork of the source code and [submit a pull request to the project][fs2-pulls]. If you don't know what you could help with, take a look at [the issues marked as "help wanted"][low-hanging-fruit] or ask on [Discord][fs2-dev].

We follow similar rules to [the cats-effect project's](https://github.com/typelevel/cats-effect#development).
Most importantly, any contributions are expected to be made in the form of [GitHub pull requests to the FS2 repository][fs2-pulls].
Expand Down
14 changes: 12 additions & 2 deletions io/shared/src/main/scala/fs2/io/process/Process.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,26 @@ sealed trait Process[F[_]] {

/** A `Pipe` that writes to `stdin` of the process. The resulting stream should be compiled
* at most once, and interrupting or otherwise canceling a write-in-progress may kill the process.
* If the process expects data through `stdin`, you have to supply it or close it. Failure to do so
* may cause the process to block, or even deadlock.
*
* `stdin` resulting stream can be closed like this:
*
* @example {{{
* Stream.empty.through(stdin).compile.drain
* }}}
*/
def stdin: Pipe[F, Byte, Nothing]

/** A `Stream` that reads from `stdout` of the process. This stream should be compiled at most once,
* and interrupting or otherwise canceling a read-in-progress may kill the process.
* and interrupting or otherwise canceling a read-in-progress may kill the process. Not draining
* this `Stream` may cause the process to block, or even deadlock.
*/
def stdout: Stream[F, Byte]

/** A `Stream` that reads from `stderr` of the process. This stream should be compiled at most once,
* and interrupting or otherwise canceling a read-in-progress may kill the process.
* and interrupting or otherwise canceling a read-in-progress may kill the process. Not draining
* this `Stream` may cause the process to block, or even deadlock.
*/
def stderr: Stream[F, Byte]

Expand Down