paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-02 13:03:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

api-docs: Add comma to all uses of "e.g." in API docs.

Browse Source
This commit is contained in:
Lauryn Menard
2024-07-04 12:14:37 +02:00
committed by Tim Abbott
parent f325a7667a
commit 2bb037f2a0
9 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
api_docs/incoming-webhooks-walkthrough.md
View File

@@ -71,7 +71,7 @@ integration uses.
In the `zerver/webhooks/` directory, create new subdirectory that will
contain all of the corresponding code. In our example it will be
`helloworld`. The new directory will be a python package, so you have
to create an empty `__init__.py` file in that directory via e.g.
to create an empty `__init__.py` file in that directory via e.g.,
`touch zerver/webhooks/helloworld/__init__.py`.
## Step 2: Create main webhook code
@@ -128,7 +128,7 @@ https://zulip.readthedocs.io/en/latest/tutorials/writing-views.html#request-vari
You must pass the name of your integration to the
`webhook_view` decorator; that name will be used to
describe your integration in Zulip's analytics (e.g. the `/stats`
describe your integration in Zulip's analytics (e.g., the `/stats`
page). Here we have used `HelloWorld`. To be consistent with other
integrations, use the name of the product you are integrating in camel
case, spelled as the product spells its own name (except always first