https://github.com/JuliaLang/julia
Revision 4c2df211bf0fdb331347e283a164311feed59f1b authored by James Wrigley on 08 February 2024, 11:55:17 UTC, committed by GitHub on 08 February 2024, 11:55:17 UTC
The reasoning is that `Pipe` is specifically documented in other
functions that are part of the public API (e.g. `redirect_stdio()`), so
it should be documented too. Same goes for `link_pipe!()` since it's
mentioned in the `Pipe` docstring.

The other function that could be documented is `open_pipe!()`, but that
specifically applies to `PipeEndpoint`'s and I could imagine that we
want it to be difficult to create a half-initialized `Pipe`
:sweat_smile: I wrote a docstring for `link_pipe!()` based off the libuv
docs: https://docs.libuv.org/en/v1.x/pipe.html#c.uv_pipe
1 parent b5bd10e
Raw File
Tip revision: 4c2df211bf0fdb331347e283a164311feed59f1b authored by James Wrigley on 08 February 2024, 11:55:17 UTC
Add `Pipe` to the documentation (#53202)
Tip revision: 4c2df21
.git-blame-ignore-revs
# .git-blame-ignore-revs
# whitespace: end text files with single newlines
3903fa54a638d4546ef50e56f91f0705a8ab11ef
# whitespace: use only UNIX line endings (\n)
e66bfa5dd32f93e76068c00ad882c1fc839c5af8
# whitespace: replace non-breaking space => space
100a741e7ab38c91d48cc929bb001afc8e09261f
# whitespace: replace tabs => space
b03e8ab9c7bd3e001add519571858fa04d6a249b
back to top