Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: In api.md add the tools/ part before test-backend. 

In this section of the docs, two tools for testing openapi
documentation are mentioned. But for the second one, we
forgot to mention that the tool also resides in the tools/
folder (like the first one which explicitly mentions it).
This commit fixes that.
This commit is contained in:
Hemanth V. Alluri 2019-08-08 08:00:13 +05:30 committed by Tim Abbott
parent 6bca996e2e
commit cfa6270080
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/documentation/api.md
View File

@ -194,7 +194,7 @@ above.
You can check your formatting using two helpful tools. You can check your formatting using two helpful tools.
* `tools/check-openapi` will verify the syntax of `zerver/openapi/zulip.yaml`. * `tools/check-openapi` will verify the syntax of `zerver/openapi/zulip.yaml`.
* `test-backend zerver/tests/test_openapi.py`; this test compares * `tools/test-backend zerver/tests/test_openapi.py`; this test compares
your documentation against the code and can find many common your documentation against the code and can find many common
mistakes in how arguments are declared. mistakes in how arguments are declared.