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
History
Tip revision: 4c2df211bf0fdb331347e283a164311feed59f1b authored by James Wrigley on 08 February 2024, 11:55:17 UTC
Add `Pipe` to the documentation (#53202)
Tip revision: 4c2df21
File Mode Size
.devcontainer
.github
base
cli
contrib
deps
doc
etc
src
stdlib
test
.buildkite-external-version -rw-r--r-- 5 bytes
.clang-format -rw-r--r-- 3.3 KB
.clangd -rw-r--r-- 114 bytes
.codecov.yml -rw-r--r-- 52 bytes
.git-blame-ignore-revs -rw-r--r-- 371 bytes
.gitattributes -rw-r--r-- 65 bytes
.gitignore -rw-r--r-- 571 bytes
.mailmap -rw-r--r-- 12.7 KB
CITATION.bib -rw-r--r-- 513 bytes
CITATION.cff -rw-r--r-- 940 bytes
CONTRIBUTING.md -rw-r--r-- 23.4 KB
HISTORY.md -rw-r--r-- 372.8 KB
LICENSE.md -rw-r--r-- 1.3 KB
Make.inc -rw-r--r-- 55.9 KB
Makefile -rw-r--r-- 30.2 KB
NEWS.md -rw-r--r-- 11.5 KB
README.md -rw-r--r-- 7.4 KB
THIRDPARTY.md -rw-r--r-- 3.9 KB
VERSION -rw-r--r-- 11 bytes
julia.spdx.json -rw-r--r-- 37.8 KB
pkgimage.mk -rw-r--r-- 5.9 KB
sysimage.mk -rw-r--r-- 4.2 KB
typos.toml -rw-r--r-- 78 bytes

README.md

back to top