From 04e2728cb031f7104d2c142a990f032e41a3f3b5 Mon Sep 17 00:00:00 2001 From: Lauryn Menard Date: Tue, 9 Jul 2024 17:57:53 +0200 Subject: [PATCH] documentation: Revise uses of "e.g.," followed by a colon. --- docs/contributing/how-we-communicate.md | 7 ++++--- docs/development/setup-recommended.md | 4 ++-- docs/documentation/api.md | 2 +- docs/production/export-and-import.md | 2 +- docs/production/management-commands.md | 2 +- docs/subsystems/settings.md | 5 +++-- docs/testing/typescript.md | 2 +- docs/translating/internationalization.md | 4 ++-- help/include/when-to-start-a-new-topic.md | 2 +- help/setting-up-zulip-for-a-class.md | 3 ++- help/using-zulip-for-a-class.md | 6 +++--- 11 files changed, 21 insertions(+), 18 deletions(-) diff --git a/docs/contributing/how-we-communicate.md b/docs/contributing/how-we-communicate.md index 1b02ca304f..285c3618aa 100644 --- a/docs/contributing/how-we-communicate.md +++ b/docs/contributing/how-we-communicate.md @@ -60,7 +60,7 @@ better decisions as a group, and learn and have fun along the way. where they are coming from. - If you think someone is factually mistaken, consider how they might have reached - their conclusion, and aim to get to a shared understanding. E.g.,: + their conclusion, and aim to get to a shared understanding. For example: - “I wasn't able to replicate this -- is it possible you are on an old Zulip server?”, rather than “This bug report is wrong.” @@ -86,7 +86,8 @@ question in the development community, or suggesting a new feature. It's especially important to thank and encourage folks who are stretching themselves to try something new. -- Remember to say “thanks” when responding to a question or suggestion. E.g.,: +- Remember to say “thanks” when responding to a question or suggestion. For + example: - “Thanks for the report! ... ” when someone reports a bug. - “Thanks for reviewing my PR! ... ” @@ -101,7 +102,7 @@ to try something new. - You can use a variety of channels to express your appreciation. A comment directly in a Zulip thread or on a pull request is often best, but in some - cases you may also want to send a friendly direct message. E.g.,: + cases you may also want to send a friendly direct message. For example: - “I've noticed that you've been answering lots of questions in #**development help** lately. Thanks so much for doing that!” diff --git a/docs/development/setup-recommended.md b/docs/development/setup-recommended.md index ce32b42040..14e5f49d07 100644 --- a/docs/development/setup-recommended.md +++ b/docs/development/setup-recommended.md @@ -132,7 +132,7 @@ installation method described here. We require version 0.67.6+ of WSL 2. $ sudo apt install rabbitmq-server memcached redis-server postgresql ``` -1. Open `/etc/rabbitmq/rabbitmq-env.conf` using e.g.,: +1. Open `/etc/rabbitmq/rabbitmq-env.conf` using, for example: ```console $ sudo nano /etc/rabbitmq/rabbitmq-env.conf @@ -1094,7 +1094,7 @@ NO_PROXY localhost,127.0.0.1,.example.com,.zulipdev.com ``` For proxies that require authentication, the config will be a bit more -complex, e.g.,: +complex, for example: ```text HTTP_PROXY http://userName:userPassword@192.168.1.1:8080 diff --git a/docs/documentation/api.md b/docs/documentation/api.md index fc5718fc6c..bdafc0662b 100644 --- a/docs/documentation/api.md +++ b/docs/documentation/api.md @@ -393,7 +393,7 @@ documentation for the REST API endpoint for uploading a file, There are no parameters for this endpoint, and only one return value specific to this endpoint, `uri`, which is the URL of the uploaded file. If we comment out that return value and example from the existing API -documentation in `zerver/openapi/zulip.yaml`, e.g.,: +documentation in `zerver/openapi/zulip.yaml`, for example: ```yaml /user_uploads: diff --git a/docs/production/export-and-import.md b/docs/production/export-and-import.md index 9b80bfc826..c475fa97bc 100644 --- a/docs/production/export-and-import.md +++ b/docs/production/export-and-import.md @@ -468,7 +468,7 @@ If you're hosting multiple organizations and would like to remove uploads from a single organization, you'll need to access `realm.id` in the management shell before deleting the organization from the database (this will be `2` for the first organization created on a -Zulip server, shown in the example below), e.g.,: +Zulip server, shown in the example below), for example: ```bash rm -rf /home/zulip/uploads/*/2/ diff --git a/docs/production/management-commands.md b/docs/production/management-commands.md index 1c914fbd56..4e5e8ca635 100644 --- a/docs/production/management-commands.md +++ b/docs/production/management-commands.md @@ -54,7 +54,7 @@ unlikely to ever need to interact with that realm.) Unless you are [hosting multiple organizations on your Zulip server](multiple-organizations.md), your single Zulip organization on the root domain will have the empty -string (`''`) as its `string_id`. So you can run e.g.,: +string (`''`) as its `string_id`. So you can run, for example: ```console zulip@zulip:~$ /home/zulip/deployments/current/manage.py show_admins -r '' diff --git a/docs/subsystems/settings.md b/docs/subsystems/settings.md index 392e53a0a1..faa42484bf 100644 --- a/docs/subsystems/settings.md +++ b/docs/subsystems/settings.md @@ -29,7 +29,7 @@ Zulip uses the [Django settings system](https://docs.djangoproject.com/en/5.0/topics/settings/), which means that the settings files are Python programs that set a lot of variables with all-capital names like `EMAIL_GATEWAY_PATTERN`. You can -access these anywhere in the Zulip Django code using e.g.,: +access these anywhere in the Zulip Django code using, for example: ```python from django.conf import settings @@ -37,7 +37,8 @@ print(settings.EMAIL_GATEWAY_PATTERN) ``` Additionally, if you need to access a Django setting in a shell -script (or just on the command line for debugging), you can use e.g.,: +script (or just on the command line for debugging), you can use, for +example: ```console $ ./scripts/get-django-setting EMAIL_GATEWAY_PATTERN diff --git a/docs/testing/typescript.md b/docs/testing/typescript.md index fe425600a0..3b777cbb32 100644 --- a/docs/testing/typescript.md +++ b/docs/testing/typescript.md @@ -82,7 +82,7 @@ those that: When migrating a module, we want to be especially thoughtful about putting together a commit structure that makes mistakes unlikely and -the changes easy to verify. E.g.,: +the changes easy to verify. For example: - First a commit that just converts the language to TypeScript adding types. The result may potentially have some violations of the diff --git a/docs/translating/internationalization.md b/docs/translating/internationalization.md index d6ed52df73..8e28dc6054 100644 --- a/docs/translating/internationalization.md +++ b/docs/translating/internationalization.md @@ -172,7 +172,7 @@ from django.utils.translation import gettext as _ Zulip expects all the error messages to be translatable as well. To ensure this, the error message passed to `JsonableError` should always be a literal string enclosed by `_()` -function, e.g.,: +function, for example: ```python JsonableError(_('English text')) @@ -180,7 +180,7 @@ JsonableError(_('English text')) If you're declaring a user-facing string at top level or in a class, you need to use `gettext_lazy` instead, to ensure that the translation happens at -request-processing time when Django knows what language to use, e.g.,: +request-processing time when Django knows what language to use, for example: ```python from zproject.backends import check_password_strength, email_belongs_to_ldap diff --git a/help/include/when-to-start-a-new-topic.md b/help/include/when-to-start-a-new-topic.md index 2dc0aa5f3d..531e36553a 100644 --- a/help/include/when-to-start-a-new-topic.md +++ b/help/include/when-to-start-a-new-topic.md @@ -2,7 +2,7 @@ To get the full benefits of Zulip's topic model, when starting a new conversation, you should start a new topic! Starting a topic is like a lighter weight version of giving your email a subject. -Topic names should be brief but specific, e.g.,: +Topic names should be brief but specific, for example: * **Good topic names:** "question about topics", "welcome Anna Smith!", "issue #1234" * **Not so good topic names:** "question", "hi", "help", "this topic is about diff --git a/help/setting-up-zulip-for-a-class.md b/help/setting-up-zulip-for-a-class.md index dc979ed3ed..6f27edab59 100644 --- a/help/setting-up-zulip-for-a-class.md +++ b/help/setting-up-zulip-for-a-class.md @@ -329,7 +329,8 @@ product. If you plan to use the same Zulip organization in future terms (either for your own classes or for your department), you will likely want to: -- Rename all channels to indicate the class and term in which they were used, e.g.,: +- Rename all channels to indicate the class and term in which they were used, for + example: - **#announcements** → **#FA21 - CS101 - announcements** - **#CS101 > Lecture 1: Course intro** → **#FA21 - CS101 > Lecture 1: Course intro** diff --git a/help/using-zulip-for-a-class.md b/help/using-zulip-for-a-class.md index 661625d015..152b21274d 100644 --- a/help/using-zulip-for-a-class.md +++ b/help/using-zulip-for-a-class.md @@ -20,14 +20,14 @@ single place for: [Subscribe to email notifications](/help/channel-notifications) for channels such as **#announcements** to make sure you never miss an important message. -Many classes use a dedicated channel to post general announcements, e.g.,: +Many classes use a dedicated channel to post general announcements, for example: * **\#announcements** > **office hours**: My office hours this week will be rescheduled from `Mon, Oct 11 2021, 1:00 PM` to `Thu, Oct 14 2021, 3:30 PM`. Share lecture notes and reading materials with [drag-and-drop file -uploads](/help/share-and-upload-files), e.g.,: +uploads](/help/share-and-upload-files), for example: * **\#Unit 3: Sorting algorithms** > **lecture notes**: Here are the notes from today’s lecture. [lecture notes 10/2.pdf]() You can view a recording of the lecture [here](). @@ -70,7 +70,7 @@ staff to see which conversations still require their attention. ## Coordination among teaching staff -Use private channels to coordinate among course staff, e.g.,: +Use private channels to coordinate among course staff, for example: * **\#staff** > **homework 2 exercise 3b**: How many points should I take off for this? The assignment says clearly to use Python 3 syntax.