Skip to content

Commit

Permalink
Explain the usage of av skip tag.
Browse files Browse the repository at this point in the history
Related to trivial edits on documentation source files #11766 (comment)

Improved explanation.

Fix typo

[av skip]
  • Loading branch information
Ismael-VC authored and tkelman committed Jun 20, 2015
1 parent ab6d485 commit 8bc1b8e
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,8 @@ Julia's documentation is stored in the `doc` directory, and like everything else
- Search for the function you want to change
- Make your changes
- Exit Zen mode
- Provide a title, and optionally a longer description of your change
- Provide a title
- Provide a longer description of your change with the tag `[av skip]` included at the bottom (this is used in order to prevent the AppVeyor job queue from growing too large because of documentation edits)
- Submit your change

Julia's documentation is built with [Sphinx](http:https://sphinx-doc.org/contents.html), which supports (and Julia's docs rely heavily on) [ReST directives](http:https://docutils.sourceforge.net/docs/ref/rst/directives.html). To build the documentation locally, run
Expand Down

0 comments on commit 8bc1b8e

Please sign in to comment.