From dd48dbd912a5e4038286065498bd76b93ff9208d Mon Sep 17 00:00:00 2001 From: Anders Kaseorg Date: Tue, 13 Oct 2020 14:50:18 -0700 Subject: [PATCH] =?UTF-8?q?docs:=20Add=20spaces=20to=20=E2=80=9Ccheck=20ou?= =?UTF-8?q?t=E2=80=9D,=20=E2=80=9Clog=20in=E2=80=9D,=20=E2=80=9Cset=20up?= =?UTF-8?q?=E2=80=9D,=20=E2=80=9Csign=20up=E2=80=9D=20as=20verbs.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit “Checkout”, “login”, “setup”, and “signup” are nouns, not verbs. Signed-off-by: Anders Kaseorg --- .github/workflows/codeql-analysis.yml | 6 +++--- corporate/tests/test_stripe.py | 4 ++-- docs/git/cheat-sheet.md | 2 +- docs/git/cloning.md | 2 +- docs/git/collaborate.md | 6 +++--- docs/git/pull-requests.md | 2 +- docs/git/using.md | 2 +- docs/git/zulip-tools.md | 4 ++-- docs/production/export-and-import.md | 4 ++-- docs/tutorials/screenshot-and-gif-software.md | 2 +- scripts/lib/upgrade-zulip-stage-2 | 2 +- static/js/overlays.js | 2 +- templates/corporate/zephyr-mirror.html | 4 ++-- templates/zerver/email_log.html | 2 +- templates/zerver/integrations/errbot.md | 2 +- tools/lib/provision.py | 2 +- tools/setup/emoji/build_emoji | 8 ++++---- zerver/decorator.py | 2 +- zerver/lib/export.py | 2 +- zerver/lib/webhooks/common.py | 2 +- zerver/tests/test_auth_backends.py | 6 +++--- 21 files changed, 34 insertions(+), 34 deletions(-) diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 74c5830dae..c650610997 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -7,14 +7,14 @@ jobs: runs-on: ubuntu-latest steps: - - name: Checkout repository + - name: Check out repository uses: actions/checkout@v2 with: # We must fetch at least the immediate parents so that if this is - # a pull request then we can checkout the head. + # a pull request then we can check out the head. fetch-depth: 2 - # If this run was triggered by a pull request event, then checkout + # If this run was triggered by a pull request event, then check out # the head of the pull request instead of the merge commit. - run: git checkout HEAD^2 if: ${{ github.event_name == 'pull_request' }} diff --git a/corporate/tests/test_stripe.py b/corporate/tests/test_stripe.py index f085a36c7e..45d07458dc 100644 --- a/corporate/tests/test_stripe.py +++ b/corporate/tests/test_stripe.py @@ -1216,7 +1216,7 @@ class StripeTest(StripeTestCase): @mock_stripe() def test_payment_method_string(self, *mocks: Mock) -> None: pass - # If you signup with a card, we should show your card as the payment method + # If you sign up with a card, we should show your card as the payment method # Already tested in test_initial_upgrade # If you pay by invoice, your payment method should be @@ -1228,7 +1228,7 @@ class StripeTest(StripeTestCase): # stripe_customer = stripe_get_customer(Customer.objects.get(realm=user.realm).stripe_customer_id) # self.assertEqual('Billed by invoice', payment_method_string(stripe_customer)) - # If you signup with a card and then downgrade, we still have your + # If you sign up with a card and then downgrade, we still have your # card on file, and should show it # TODO diff --git a/docs/git/cheat-sheet.md b/docs/git/cheat-sheet.md index 18b2486ad7..ba49006d1a 100644 --- a/docs/git/cheat-sheet.md +++ b/docs/git/cheat-sheet.md @@ -60,7 +60,7 @@ See also [fixing commits][fix-commit] - `git add foo.py bar.py`: add `foo.py` AND `bar.py` to the staging area - `git add -u`: Adds all tracked files to the staging area. - checkout - - `git checkout -b new-branch-name`: create branch `new-branch-name` and switch/checkout to that new branch + - `git checkout -b new-branch-name`: create branch `new-branch-name` and switch to/check out that new branch - `git checkout master`: switch to your `master` branch - `git checkout old-branch-name`: switch to an existing branch `old-branch-name` - commit diff --git a/docs/git/cloning.md b/docs/git/cloning.md index 2f8c1c0244..cc8e7f7792 100644 --- a/docs/git/cloning.md +++ b/docs/git/cloning.md @@ -8,7 +8,7 @@ accepted. We also recommend you work on feature branches. ## Step 1a: Create your fork -The following steps you'll only need to do the first time you setup a machine +The following steps you'll only need to do the first time you set up a machine for contributing to a given Zulip project. You'll need to repeat the steps for any additional Zulip projects ([list][github-zulip]) that you work on. diff --git a/docs/git/collaborate.md b/docs/git/collaborate.md index d72ecdc0ed..4c00ec1d88 100644 --- a/docs/git/collaborate.md +++ b/docs/git/collaborate.md @@ -11,7 +11,7 @@ $ git remote add https://github.com//zulip.git $ git fetch ``` -Now you can checkout their branch just like you would any other. You can name +Now you can check out their branch just like you would any other. You can name the branch anything you want, but using both the username and branch name will help you keep things organized. @@ -24,9 +24,9 @@ You can choose to rename the branch if you prefer: git checkout -b / ``` -## Checkout a pull request locally +## Check out a pull request locally -Just as you can checkout any user's branch locally, you can also checkout any +Just as you can check out any user's branch locally, you can also check out any pull request locally. GitHub provides a special syntax ([details][github-help-co-pr-locally]) for this since pull requests are specific to GitHub rather than Git. diff --git a/docs/git/pull-requests.md b/docs/git/pull-requests.md index 9af6eea8d9..0cba91b181 100644 --- a/docs/git/pull-requests.md +++ b/docs/git/pull-requests.md @@ -115,7 +115,7 @@ your pull request title with [WIP] if it is a [work-in-progress][wip-prs]. If your pull request has an effect on the visuals of a component, you might want to include a screenshot of this change or a GIF of the interaction in your first comment. This will allow reviewers to comment on your changes without having to -checkout your branch; you can find a list of tools you can use for this over +check out your branch; you can find a list of tools you can use for this over [here][screenshots-gifs]. When ready, click the green **Create pull request** to submit the pull request. diff --git a/docs/git/using.md b/docs/git/using.md index 9208eb89d6..a4a6b8970e 100644 --- a/docs/git/using.md +++ b/docs/git/using.md @@ -57,7 +57,7 @@ configured in the step above: $ git fetch upstream ``` -Next, checkout your `master` branch and [rebase][gitbook-git-rebase] it on top +Next, check out your `master` branch and [rebase][gitbook-git-rebase] it on top of `upstream/master`: ``` diff --git a/docs/git/zulip-tools.md b/docs/git/zulip-tools.md index 036b6441ea..da3a156895 100644 --- a/docs/git/zulip-tools.md +++ b/docs/git/zulip-tools.md @@ -163,7 +163,7 @@ Deleting local branch review-original-5156 (was 5a1e982) ## Merge conflict on yarn.lock file If there is a merge conflict on yarn.lock, yarn should be run to -regenerate the file. *Important* don't delete the yarn.lock file. Checkout the +regenerate the file. *Important* don't delete the yarn.lock file. Check out the latest one from origin/master so that yarn knows the previous asset versions. Run the following commands @@ -175,5 +175,5 @@ git rebase --continue ``` [github-zulip-zulip]: https://github.com/zulip/zulip/ -[zulip-git-guide-fetch-pr]: ../git/collaborate.html#checkout-a-pull-request-locally +[zulip-git-guide-fetch-pr]: ../git/collaborate.html#check-out-a-pull-request-locally [zulip-git-guide-ci]: ../git/cloning.html#step-3-configure-continuous-integration-for-your-fork diff --git a/docs/production/export-and-import.md b/docs/production/export-and-import.md index 075af7d951..7c785262f9 100644 --- a/docs/production/export-and-import.md +++ b/docs/production/export-and-import.md @@ -185,7 +185,7 @@ will be stored in that directory and you'll want to back it up. * Your Zulip configuration including secrets from `/etc/zulip/`. E.g. if you lose the value of `secret_key`, all users will need to -login again when you set up a replacement server since you won't be +log in again when you set up a replacement server since you won't be able to verify their cookies. If you lose `avatar_salt`, any user-uploaded avatars will need to be re-uploaded (since avatar filenames are computed using a hash of `avatar_salt` and user's @@ -266,7 +266,7 @@ preventing all accounts from logging in or accessing the API. This is preferred for environments like Zulip Cloud where you might want to export a single organization without disrupting any other users, and the intent is to move hosting of the organization (and forcing users -to re-login would be required as part of the hosting migration +to re-log in would be required as part of the hosting migration anyway). We include both options in the instructions below, commented out so diff --git a/docs/tutorials/screenshot-and-gif-software.md b/docs/tutorials/screenshot-and-gif-software.md index 24bfa36da9..e6f26b057f 100644 --- a/docs/tutorials/screenshot-and-gif-software.md +++ b/docs/tutorials/screenshot-and-gif-software.md @@ -3,7 +3,7 @@ The following list documents different screenshoting & GIF-making techniques and free software. We encourage you to make use of these when making front-end pull requests, as other contributors can see the changes you have made without having -to checkout your branch. +to check out your branch. ## Screenshot tools by platform ### Browser diff --git a/scripts/lib/upgrade-zulip-stage-2 b/scripts/lib/upgrade-zulip-stage-2 index 01dd567c2b..69bc998f18 100755 --- a/scripts/lib/upgrade-zulip-stage-2 +++ b/scripts/lib/upgrade-zulip-stage-2 @@ -151,7 +151,7 @@ if not os.path.exists(os.path.join(deploy_path, "zproject/prod_settings.py")): subprocess.check_call([os.path.join(deploy_path, "scripts", "lib", "create-production-venv"), deploy_path]) -# Setup the thumbor venv +# Set up the thumbor venv subprocess.check_call([os.path.join(deploy_path, "scripts", "lib", "create-thumbor-venv"), deploy_path]) diff --git a/static/js/overlays.js b/static/js/overlays.js index b4d951f7a0..59d2679d8b 100644 --- a/static/js/overlays.js +++ b/static/js/overlays.js @@ -163,7 +163,7 @@ exports.close_overlay = function (name) { $(".header").attr("aria-hidden", "false"); if (!close_handler) { - blueslip.error("Overlay close handler for " + name + " not properly setup."); + blueslip.error("Overlay close handler for " + name + " not properly set up."); return; } diff --git a/templates/corporate/zephyr-mirror.html b/templates/corporate/zephyr-mirror.html index ea7aa2eeb1..697d027653 100644 --- a/templates/corporate/zephyr-mirror.html +++ b/templates/corporate/zephyr-mirror.html @@ -40,7 +40,7 @@ mirror script instead of using Webathena.

Mirroring without a BarnOwl session

If you are not already running a screen/tmux for BarnOwl, you - can setup a screen session to run the Zephyr mirroring script by + can set up a screen session to run the Zephyr mirroring script by running the following on a dialup such as linerva.mit.edu:

@@ -56,7 +56,7 @@ mirror script instead of using Webathena.

session, and use `/mit/kchen/bin/cont-renew-notify` to continually renew your Kerberos tickets for up to a week; each week, it will send you a Zephyr/Zulip letting you know that you need to renew - your tickets. To do so, log in to the server that you setup the + your tickets. To do so, log in to the server that you set up the screen session on and use the following procedure:

    diff --git a/templates/zerver/email_log.html b/templates/zerver/email_log.html index 659d7c5404..f807a159ec 100644 --- a/templates/zerver/email_log.html +++ b/templates/zerver/email_log.html @@ -48,7 +48,7 @@
    - You must setup SMTP as described + You must set up SMTP as described here first before enabling this.
    diff --git a/templates/zerver/integrations/errbot.md b/templates/zerver/integrations/errbot.md index 63fd75eaec..bc92f7b714 100644 --- a/templates/zerver/integrations/errbot.md +++ b/templates/zerver/integrations/errbot.md @@ -1,7 +1,7 @@ Run your favorite chatbot in Zulip! 0. [Install errbot](https://errbot.readthedocs.io/en/latest/user_guide/setup.html) - and follow to instructions to setup a `config.py`. + and follow to instructions to set up a `config.py`. 0. Check our our [Errbot integration package for Zulip](https://github.com/zulip/errbot-backend-zulip) Clone this repository somewhere convenient. diff --git a/tools/lib/provision.py b/tools/lib/provision.py index 29bef1d740..cd8c06918c 100755 --- a/tools/lib/provision.py +++ b/tools/lib/provision.py @@ -41,7 +41,7 @@ CONTINUOUS_INTEGRATION = 'GITHUB_ACTIONS' in os.environ or 'CIRCLECI' in os.envi if not os.path.exists(os.path.join(ZULIP_PATH, ".git")): print(FAIL + "Error: No Zulip git repository present!" + ENDC) - print("To setup the Zulip development environment, you should clone the code") + print("To set up the Zulip development environment, you should clone the code") print("from GitHub, rather than using a Zulip production release tarball.") sys.exit(1) diff --git a/tools/setup/emoji/build_emoji b/tools/setup/emoji/build_emoji index 83f32ca9e7..98b185ac0e 100755 --- a/tools/setup/emoji/build_emoji +++ b/tools/setup/emoji/build_emoji @@ -166,7 +166,7 @@ def generate_sprite_css_files(cache_path: str, # Why is the test here has_img_google and not # emoji_is_universal? Because we briefly supported all # Google emoji (not just the universal ones), we need to - # ensure the spritesheet is setup to correctly display + # ensure the spritesheet is set up to correctly display # those google emoji (in case anyone used them). """ @@ -276,11 +276,11 @@ def setup_emoji_farms(cache_path: str, emoji_data: List[Dict[str, Any]]) -> None generate_sprite_css_files(cache_path, emoji_data, emojiset, alt_name) - # Setup standard emojisets. + # Set up standard emojisets. for emojiset in ['google', 'twitter']: setup_emoji_farm(emojiset, emoji_data) - # Setup old google "blobs" emojiset. + # Set up old google "blobs" emojiset. GOOGLE_BLOB_EMOJI_DATA_PATH = os.path.join(NODE_MODULES_PATH, 'emoji-datasource-google-blob', 'emoji.json') @@ -348,7 +348,7 @@ def dump_emojis(cache_path: str) -> None: emoji_data = orjson.loads(emoji_data_file.read()) emoji_catalog = generate_emoji_catalog(emoji_data, EMOJI_NAME_MAPS) - # Setup emoji farms. + # Set up emoji farms. if os.path.exists(cache_path): shutil.rmtree(cache_path) setup_emoji_farms(cache_path, emoji_data) diff --git a/zerver/decorator.py b/zerver/decorator.py index 1dd237712e..1aa3da7908 100644 --- a/zerver/decorator.py +++ b/zerver/decorator.py @@ -795,7 +795,7 @@ def zulip_otp_required( if not user.is_authenticated: # nocoverage return True - # If the user doesn't have 2FA setup, we can't enforce 2FA. + # If the user doesn't have 2FA set up, we can't enforce 2FA. if not user_has_device(user): return True diff --git a/zerver/lib/export.py b/zerver/lib/export.py index 03fb111df8..646c9aec40 100644 --- a/zerver/lib/export.py +++ b/zerver/lib/export.py @@ -181,7 +181,7 @@ NON_EXPORTED_TABLES = { # expire after a few days. 'zerver_missedmessageemailaddress', - # When switching servers, clients will need to re-login and + # When switching servers, clients will need to re-log in and # reregister for push notifications anyway. 'zerver_pushdevicetoken', diff --git a/zerver/lib/webhooks/common.py b/zerver/lib/webhooks/common.py index 191b106de2..b5a2b87497 100644 --- a/zerver/lib/webhooks/common.py +++ b/zerver/lib/webhooks/common.py @@ -25,7 +25,7 @@ Contact {support_email} if you need help debugging! """ INVALID_JSON_MESSAGE = """ -Hi there! It looks like you tried to setup the Zulip {webhook_name} integration, +Hi there! It looks like you tried to set up the Zulip {webhook_name} integration, but didn't correctly configure the webhook to send data in the JSON format that this integration expects! """ diff --git a/zerver/tests/test_auth_backends.py b/zerver/tests/test_auth_backends.py index ee82fa39c9..86cbbe2a6d 100644 --- a/zerver/tests/test_auth_backends.py +++ b/zerver/tests/test_auth_backends.py @@ -818,7 +818,7 @@ class SocialAuthBase(DesktopFlowTestingLib, ZulipTestCase): /register (True) or /login (False). This is important because we need to verify behavior like the "Continue to registration" if you try to log in using an - account that doesn't exist but is allowed to signup. + account that doesn't exist but is allowed to sign up. * next: Parameter passed through in production authentication to redirect the user to (e.g.) the specific page in the webapp that they clicked a link to before being presented with the login @@ -1282,12 +1282,12 @@ class SocialAuthBase(DesktopFlowTestingLib, ZulipTestCase): multiuse_object_key = multiuse_confirmation.confirmation_key account_data_dict = self.get_account_data_dict(email=email, name=name) - # First, try to signup for closed realm without using an invitation + # First, try to sign up for closed realm without using an invitation result = self.social_auth_test(account_data_dict, expect_choose_email_screen=True, subdomain=subdomain, is_signup=True) result = self.client_get(result.url) - # Verify that we're unable to signup, since this is a closed realm + # Verify that we're unable to sign up, since this is a closed realm self.assertEqual(result.status_code, 200) self.assert_in_success_response(["Sign up"], result)