Document Makefile syntax for genstdlib documentation

jiahao · Jan 2, 2016 · b2f333d · b2f333d
1 parent 5e72ae2
commit b2f333d
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -99,6 +99,7 @@ from Julia's root directory. Sometimes errors only show up in one of them, so if
 Existing docstrings now live primarily in `base/docs/helpdb.jl`.
 It is a goal over time to move the docstrings inline to their respective method definitions.
 If you want to edit the body of a method docstring, run the `doc/genstdlib.jl` script to regenerate the restructured text files **after** you have already rebuilt Julia.
+(From the top-level source directory, you can do this with `make julia-genstdlib`.)
 If you want to edit an existing docstring signature, you **first** have to change the signature in the `doc/stdlib` `..function` or `..data` definition (not the auto-generated content) and *then*
 edit the helpdb.jl or inline method docstrings. The existing signatures in the `doc/stdlib/*.rst` files are pattern matched to base docstrings and the new content overwrites the content in `doc/stdlib/`.
 The signature definitions **must** be in sync or else the pattern match will fail and documentation will be lost in the result.

diff --git a/doc/stdlib/io-network.rst b/doc/stdlib/io-network.rst
@@ -404,7 +404,7 @@ Text I/O
 
  .. Docstring generated from Julia source
 
- Show a more compact representation of a value. This is used for printing array elements. If a new type has a different compact representation, it should test ``Base.limit_output(io)`` in its ``show`` method.
+ Show a more compact representation of a value. This is used for printing array elements. If a new type has a different compact representation, it should test ``Base.limit_output(io)`` in its normal ``show`` method.
 
 .. function:: showall(x)