paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-23 04:52:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Improve formatting of important notes.

Browse Source 
Improves formatting using reST and Sphinx admonition directives
so that important notes stand out when viewed in ReadTheDocs.
This commit is contained in:
David Rosa
2019-11-25 15:25:49 -08:00
committed by Tim Abbott
parent cd2c68c778
commit 62d555115a
4 changed files with 33 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/testing/linters.md
View File

@@ -51,12 +51,15 @@ note are:
Finally, you can rely on our Travis CI setup to run linters for you, but
it is good practice to run lint checks locally.
**Important:** We provide a
[Git pre-commit hook](http://localhost:9991/docs/git/zulip-tools.html#set-up-git-repo-script)
that can automatically run `tools/lint` on just the files that
changed (in a few 100ms) whenever you make a commit. This can save
you a lot of time, by automatically detecting linter errors as you
make them.
```eval_rst
.. important::
We provide a
`Git pre-commit hook <../git/zulip-tools.html#set-up-git-repo-script>`_
that can automatically run ``tools/lint`` on just the files that
changed (in a few 100ms) whenever you make a commit. This can save
you a lot of time, by automatically detecting linter errors as you
make them.
```
**Note:** The linters only check files that git tracks. Remember to `git add`
new files before running lint checks.