From 5c62e303b5ab7c0f38b360c3918380ccd011a536 Mon Sep 17 00:00:00 2001 From: a1346054 <36859588+a1346054@users.noreply.github.com> Date: Thu, 16 Sep 2021 03:32:13 +0000 Subject: [PATCH] *: shellcheck and fix typos (#6526) * test.sh: quote a variable * contributing-guides/*: fix typos * pages/*: fix typos * scripts/*: fix typos * MAINTAINERS.md: trim trailing whitespace Co-authored-by: a1346054 <36859588+a1346054@users.noreply.github.com> --- MAINTAINERS.md | 4 ++-- contributing-guides/git-terminal.md | 4 ++-- .../translation-templates/subcommand-mention.md | 2 +- pages/common/az-vm.md | 4 ++-- pages/common/git-summary.md | 2 +- pages/common/pio-platform.md | 2 +- pages/common/tlmgr-paper.md | 2 +- pages/linux/ffuf.md | 2 +- scripts/build.sh | 4 ++-- scripts/test.sh | 4 ++-- 10 files changed, 15 insertions(+), 15 deletions(-) diff --git a/MAINTAINERS.md b/MAINTAINERS.md index d3dac2ec4..d337a09c0 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -44,9 +44,9 @@ If you are an owner of the organization, you can see an automated list [03 May 2021](https://github.com/tldr-pages/tldr/issues/5873) — present - **Patrice Denis ([@patricedenis](https://github.com/patricedenis))**: [10 May 2021](https://github.com/tldr-pages/tldr/issues/5919) — present -- **Lin Cheng Chieh ([@blueskyson](https://github.com/blueskyson))**: +- **Lin Cheng Chieh ([@blueskyson](https://github.com/blueskyson))**: [12 Aug 2021](https://github.com/tldr-pages/tldr/issues/6330) — present -- **Pixel Häußler ([@pixelcmtd](https://github.com/pixelcmtd))**: +- **Pixel Häußler ([@pixelcmtd](https://github.com/pixelcmtd))**: [27 Aug 2021](https://github.com/tldr-pages/tldr/issues/6415) — present - Owen Voke ([@owenvoke](https://github.com/owenvoke)) [11 January 2018](https://github.com/tldr-pages/tldr/issues/1885) — [26 August 2018](https://github.com/tldr-pages/tldr/issues/2258) diff --git a/contributing-guides/git-terminal.md b/contributing-guides/git-terminal.md index 3d573eb82..c9ec16e51 100644 --- a/contributing-guides/git-terminal.md +++ b/contributing-guides/git-terminal.md @@ -51,7 +51,7 @@ git fetch upstream main git rebase upstream/main # in case you have any merge conflicts, click the link below to see how to resolve them git push --force-with-lease # not needed if you only want to update your local repository ``` -[How to resolve merge conficts](https://docs.github.com/en/github/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line) +[How to resolve merge conflicts](https://docs.github.com/en/github/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line) # Changing the email of your last commit @@ -75,7 +75,7 @@ Let's take this commit history as an example: | E | correct@example.org | F (HEAD) | correct@example.org -To change the email of commts A and D, run +To change the email of commits A and D, run ```bash git reset A diff --git a/contributing-guides/translation-templates/subcommand-mention.md b/contributing-guides/translation-templates/subcommand-mention.md index 183b6df97..0ba8017a2 100644 --- a/contributing-guides/translation-templates/subcommand-mention.md +++ b/contributing-guides/translation-templates/subcommand-mention.md @@ -1,6 +1,6 @@ # Mentioning sub-commands -When a command has a sub-command, which can't be covered in the original page, it get's its own page. +When a command has a sub-command, which can't be covered in the original page, it gets its own page. An example for this is `git` and it's sub-command pages like `git-commit`, `git-push`, etc. In order to notify the user that such sub-command pages exist, we put a little notice in the base command's description. This file contains the translation templates of this notice. diff --git a/pages/common/az-vm.md b/pages/common/az-vm.md index d57ee3dc0..c50f29f15 100644 --- a/pages/common/az-vm.md +++ b/pages/common/az-vm.md @@ -4,7 +4,7 @@ > Part of `az`, the command-line client for Microsoft Azure. > More information: . -- List details of availible Virtual Machines: +- List details of available Virtual Machines: `az vm list` @@ -28,6 +28,6 @@ `az vm restart --resource-group {{rg}} --name {{vm_name}}` -- List VM images availiable in the Azure Marketplace: +- List VM images available in the Azure Marketplace: `az vm image list` diff --git a/pages/common/git-summary.md b/pages/common/git-summary.md index d2e0c6cef..3663d6833 100644 --- a/pages/common/git-summary.md +++ b/pages/common/git-summary.md @@ -16,6 +16,6 @@ `git summary --dedup-by-email` -- Display data about a Git repository, showing the number of lines modified by each contributer: +- Display data about a Git repository, showing the number of lines modified by each contributor: `git summary --line` diff --git a/pages/common/pio-platform.md b/pages/common/pio-platform.md index 158415b4f..47e454510 100644 --- a/pages/common/pio-platform.md +++ b/pages/common/pio-platform.md @@ -21,7 +21,7 @@ - Update installed development platforms: -`pio platfom update` +`pio platform update` - Uninstall a development platform: diff --git a/pages/common/tlmgr-paper.md b/pages/common/tlmgr-paper.md index 9b157ad62..fcee32441 100644 --- a/pages/common/tlmgr-paper.md +++ b/pages/common/tlmgr-paper.md @@ -15,7 +15,7 @@ `tlmgr {{pdftex}} paper` -- Set the dafault paper size for a specific TeX Live program to A4: +- Set the default paper size for a specific TeX Live program to A4: `sudo tlmgr {{pdftex}} paper {{a4}}` diff --git a/pages/linux/ffuf.md b/pages/linux/ffuf.md index 796358881..8db03702b 100644 --- a/pages/linux/ffuf.md +++ b/pages/linux/ffuf.md @@ -3,7 +3,7 @@ > Subdomain and directory discovery tool. > More information: . -- Discover directories using a [w]ordlist on a target [u]rl with [c]olorized and [v]erbose ouput: +- Discover directories using a [w]ordlist on a target [u]rl with [c]olorized and [v]erbose output: `ffuf -w {{path/to/wordlist}} -u {{https://target/FUZZ}} -c -v` diff --git a/scripts/build.sh b/scripts/build.sh index 04936818f..47c4e2831 100755 --- a/scripts/build.sh +++ b/scripts/build.sh @@ -14,14 +14,14 @@ function initialize { function build_index { npm run build-index - echo "Pages index succesfully built." + echo "Pages index successfully built." } function build_archive { rm -f "$TLDR_ARCHIVE" cd "$TLDRHOME/" zip -q -r "$TLDR_ARCHIVE" pages* LICENSE.md index.json - echo "Pages archive succesfully built." + echo "Pages archive successfully built." } ################################### diff --git a/scripts/test.sh b/scripts/test.sh index 949a81b9d..c96714c92 100755 --- a/scripts/test.sh +++ b/scripts/test.sh @@ -48,7 +48,7 @@ function run_tests { markdownlint pages*/**/*.md tldr-lint ./pages for f in ./pages.*; do - tldr-lint --ignore "TLDR003,TLDR004,TLDR005,TLDR015,TLDR104" ${f} + tldr-lint --ignore "TLDR003,TLDR004,TLDR005,TLDR015,TLDR104" "${f}" done run_black run_flake8 @@ -91,4 +91,4 @@ else run_tests fi -echo 'Test ran succesfully!' +echo 'Test ran successfully!'