Skip to content

Update process' docstring to mention clojure standard streams #89

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

Merged
borkdude merged 1 commit into from
Oct 1, 2022
Merged

Update process' docstring to mention clojure standard streams #89

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 7 additions & 5 deletions src/babashka/process.cljc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,9 +148,8 @@
post-8))

(defn destroy
"Takes process or map
with :proc (`java.lang.ProcessBuilder`). Destroys the process and
returns the input arg."
"Destroys the process and returns the input arg. Takes process or map
with :proc (`java.lang.ProcessBuilder`). "
[proc]
(.destroy ^java.lang.Process (:proc proc))
proc)
Expand Down Expand Up @@ -278,8 +277,9 @@
(post-fn out)))

(defn process
"Takes a command (vector of strings or objects that will be turned
into strings) and optionally a map of options.
"Creates a child process. Takes a command (vector of strings or
objects that will be turned into strings) and optionally a map of
options.

Returns: a record with:
- `:proc`: an instance of `java.lang.Process`
Expand All @@ -300,6 +300,8 @@
to `:inherit` for redirecting to the parent process's corresponding
stream. Optional `:in-enc`, `:out-enc` and `:err-enc` values will
be passed along to `clojure.java.io/copy`.
For redirecting to Clojure's `*in*`, `*out*` or `*err*` stream, set
the corresponding option accordingly.
The `:out` and `:err` options support `:string` for writing to a string
output. You will need to `deref` the process before accessing the string
via the process's `:out`.
Expand Down