Skip to content

Commit

Permalink
Document Makefile syntax for genstdlib documentation
Browse files Browse the repository at this point in the history
(cherry picked from commit b2f333d)
  • Loading branch information
timholy authored and tkelman committed Jan 9, 2016
1 parent 2fcdcbe commit 3d0a0e0
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,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.
Expand Down

0 comments on commit 3d0a0e0

Please sign in to comment.