From d6d4561c17ca5af5613e943ff716e732f1c7fbf8 Mon Sep 17 00:00:00 2001 From: Reinhart Previano Koentjoro Date: Sun, 3 Dec 2023 19:59:57 +0700 Subject: [PATCH] pages*: fix documentation mistakes (#11641) * a2ping: minor fixes * ab: fix mnemonics * ab: fix mnemonics * ab: fix mnemonics * abduco: add mnemonics * accelerate: use Hugging Face as a trademark * ack: highlight grep as a command * acme.sh: highlight certbot as command * act: add mnemonics * ag: highlight ack as command * age-keygen: add Oxford comma * linux/shutdown: add mnemonics * airdecap-ng: use Oxford comma * alex: use standard path name template --- pages.bn/common/acme.sh.md | 2 +- pages.es/common/acme.sh.md | 2 +- pages.es/common/ag.md | 2 +- pages.fr/common/acme.sh.md | 2 +- pages.fr/common/ag.md | 2 +- pages.ja/common/ag.md | 2 +- pages.ko/common/accelerate.md | 2 +- pages.ko/common/ag.md | 2 +- pages.nl/common/accelerate.md | 2 +- pages.nl/common/acme.sh.md | 2 +- pages.nl/common/ag.md | 2 +- pages.pl/common/ag.md | 2 +- pages.pt_BR/common/acme.sh.md | 2 +- pages.pt_BR/common/ag.md | 2 +- pages.ru/common/ag.md | 2 +- pages.zh/common/acme.sh.md | 2 +- pages.zh/common/ag.md | 2 +- pages/common/a2ping.md | 4 ++-- pages/common/ab.md | 4 ++-- pages/common/abduco.md | 6 +++--- pages/common/accelerate.md | 2 +- pages/common/ack.md | 2 +- pages/common/acme.sh.md | 2 +- pages/common/act.md | 10 +++++----- pages/common/ag.md | 2 +- pages/common/age-keygen.md | 2 +- pages/common/airdecap-ng.md | 2 +- pages/common/alex.md | 2 +- pages/linux/shutdown.md | 10 +++++----- 29 files changed, 41 insertions(+), 41 deletions(-) diff --git a/pages.bn/common/acme.sh.md b/pages.bn/common/acme.sh.md index 116c447d8..d45dbec5f 100644 --- a/pages.bn/common/acme.sh.md +++ b/pages.bn/common/acme.sh.md @@ -1,6 +1,6 @@ # acme.sh -> ACME ক্লায়েন্ট প্রোটোকল প্রয়োজনীয় স্ক্রিপ্ট, certbot এর একটি বিকল্প। +> ACME ক্লায়েন্ট প্রোটোকল প্রয়োজনীয় স্ক্রিপ্ট, `certbot` এর একটি বিকল্প। > `acme.sh dns` দেখুন। > আরও তথ্য পাবেন: । diff --git a/pages.es/common/acme.sh.md b/pages.es/common/acme.sh.md index eb353f3a2..3441806fb 100644 --- a/pages.es/common/acme.sh.md +++ b/pages.es/common/acme.sh.md @@ -1,6 +1,6 @@ # acme.sh -> Shell script implementando el protocolo cliente ACME, una alternativa a certbot. +> Shell script implementando el protocolo cliente ACME, una alternativa a `certbot`. > Ver también `acme.sh dns`. > Más información: . diff --git a/pages.es/common/ag.md b/pages.es/common/ag.md index 73134238e..af0d6cd58 100644 --- a/pages.es/common/ag.md +++ b/pages.es/common/ag.md @@ -1,6 +1,6 @@ # ag -> The Silver Searcher. Como ack, pero apunta a ser más rápido. +> The Silver Searcher. Como `ack`, pero apunta a ser más rápido. > Más información: . - Encuentra archivos que contengan "foo", e imprime las líneas coincidentes en su contexto: diff --git a/pages.fr/common/acme.sh.md b/pages.fr/common/acme.sh.md index 2b1f7a1a2..1384c4a1d 100644 --- a/pages.fr/common/acme.sh.md +++ b/pages.fr/common/acme.sh.md @@ -1,6 +1,6 @@ # acme.sh -> Script shell implémentant le protocole client ACME, une alternative à certbot. +> Script shell implémentant le protocole client ACME, une alternative à `certbot`. > Voir aussi `acme.sh dns`. > Plus d'informations : . diff --git a/pages.fr/common/ag.md b/pages.fr/common/ag.md index cbe92fa9c..f3ba99568 100644 --- a/pages.fr/common/ag.md +++ b/pages.fr/common/ag.md @@ -1,6 +1,6 @@ # ag -> The Silver Searcher. Comme ack, mais inspire à être plus rapide. +> The Silver Searcher. Comme `ack`, mais inspire à être plus rapide. > Plus d'informations : . - Trouve les fichiers qui contiennent "foo", et affiche les lignes correspondantes dans le contexte courant : diff --git a/pages.ja/common/ag.md b/pages.ja/common/ag.md index 854153e22..66c3e5b72 100644 --- a/pages.ja/common/ag.md +++ b/pages.ja/common/ag.md @@ -1,6 +1,6 @@ # ag -> Silver Searcher と呼ばれます。ack コマンドに似ていますが、より高速化を目指したコマンドです。 +> Silver Searcher と呼ばれます。`ack` コマンドに似ていますが、より高速化を目指したコマンドです。 > 詳しくはこちら: - "foo"という文字列が含まれるファイルを検索し、コンテキスト内でマッチした行を出力する: diff --git a/pages.ko/common/accelerate.md b/pages.ko/common/accelerate.md index 29bc0f2c2..9ab3c4b41 100644 --- a/pages.ko/common/accelerate.md +++ b/pages.ko/common/accelerate.md @@ -11,7 +11,7 @@ `accelerate config` -- 다양한 데이터 타입을 사용하여 huggingface 모델을 실행하는 데 필요한 예상 GPU 메모리 비용을 출력: +- 다양한 데이터 타입을 사용하여 Hugging Face 모델을 실행하는 데 필요한 예상 GPU 메모리 비용을 출력: `accelerate estimate-memory {{이름/모델}}` diff --git a/pages.ko/common/ag.md b/pages.ko/common/ag.md index 0cc1e6f3d..70f7707f2 100644 --- a/pages.ko/common/ag.md +++ b/pages.ko/common/ag.md @@ -1,7 +1,7 @@ # ag > The Silver Searcher. -> ack과 비슷하지만, 더 빠르다. +> `ack` 과 비슷하지만, 더 빠르다. > 더 많은 정보: . - "foo"를 포함하고 있는 파일들을 찾고, 내용에서 일치하는 행을 출력: diff --git a/pages.nl/common/accelerate.md b/pages.nl/common/accelerate.md index 13a239f56..e17851c62 100644 --- a/pages.nl/common/accelerate.md +++ b/pages.nl/common/accelerate.md @@ -11,7 +11,7 @@ `accelerate config` -- Druk de geschatte GPU-geheugenkosten af van het uitvoeren van een huggingface model met verschillende gegevenstypen: +- Druk de geschatte GPU-geheugenkosten af van het uitvoeren van een Hugging Face model met verschillende gegevenstypen: `accelerate estimate-memory {{name/model}}` diff --git a/pages.nl/common/acme.sh.md b/pages.nl/common/acme.sh.md index 53a8e6a83..02bdb5eaf 100644 --- a/pages.nl/common/acme.sh.md +++ b/pages.nl/common/acme.sh.md @@ -1,6 +1,6 @@ # acme.sh -> Shell-script dat het ACME-clientprotocol implementeert, een alternatief voor certbot. +> Shell-script dat het ACME-clientprotocol implementeert, een alternatief voor `certbot`. > Zie ook `acme.sh dns`. > Meer informatie: . diff --git a/pages.nl/common/ag.md b/pages.nl/common/ag.md index e6d426004..e1e296912 100644 --- a/pages.nl/common/ag.md +++ b/pages.nl/common/ag.md @@ -1,6 +1,6 @@ # ag -> The Silver Searcher. Zoals ack, maar wil sneller zijn. +> The Silver Searcher. Zoals `ack`, maar wil sneller zijn. > Meer informatie: . - Zoek bestanden die "foo" bevatten en druk de regelovereenkomsten in context af: diff --git a/pages.pl/common/ag.md b/pages.pl/common/ag.md index 72946ec9e..0a6221988 100644 --- a/pages.pl/common/ag.md +++ b/pages.pl/common/ag.md @@ -1,6 +1,6 @@ # ag -> The Silver Searcher. Podobny do ack, ale ma być szybszy. +> The Silver Searcher. Podobny do `ack`, ale ma być szybszy. > Więcej informacji: . - Znajdź pliki zawierające „foo” i wypisz dopasowane linie: diff --git a/pages.pt_BR/common/acme.sh.md b/pages.pt_BR/common/acme.sh.md index 6f54c36ed..e1b272abd 100644 --- a/pages.pt_BR/common/acme.sh.md +++ b/pages.pt_BR/common/acme.sh.md @@ -1,6 +1,6 @@ # acme.sh -> Script shell script que implementa o protocolo cliente ACME, ma alternativa para o certbot. +> Script shell script que implementa o protocolo cliente ACME, ma alternativa para o `certbot`. > Veja também `acme.sh dns`. > Mais informações: . diff --git a/pages.pt_BR/common/ag.md b/pages.pt_BR/common/ag.md index 053ee2bf1..cc14c286a 100644 --- a/pages.pt_BR/common/ag.md +++ b/pages.pt_BR/common/ag.md @@ -1,6 +1,6 @@ # ag -> The Silver Searcher. Parecido com o ack, mas com um foco em ser ainda mais rápido. +> The Silver Searcher. Parecido com o `ack`, mas com um foco em ser ainda mais rápido. > Mais informações: . - Acha arquivos que contém "foo" e imprime as linhas correspondentes no contexto: diff --git a/pages.ru/common/ag.md b/pages.ru/common/ag.md index 3bf0dbafb..4d363fb5e 100644 --- a/pages.ru/common/ag.md +++ b/pages.ru/common/ag.md @@ -1,6 +1,6 @@ # ag -> The Silver Searcher. Аналог ack, но имеет цель быть быстрее. +> The Silver Searcher. Аналог `ack`, но имеет цель быть быстрее. > Больше информации: . - Найти файлы, содержащие "foo", и вывести подходящие строки в контексте: diff --git a/pages.zh/common/acme.sh.md b/pages.zh/common/acme.sh.md index 71b7632a1..decf6badc 100644 --- a/pages.zh/common/acme.sh.md +++ b/pages.zh/common/acme.sh.md @@ -1,6 +1,6 @@ # acme.sh -> 实现了 ACME 客户端协议的 shell 脚本，是 certbot 的替代品。 +> 实现了 ACME 客户端协议的 shell 脚本，是 `certbot` 的替代品。 > 另见 `acme.sh dns`。 > 更多信息：. diff --git a/pages.zh/common/ag.md b/pages.zh/common/ag.md index aacd9e9cc..d38603387 100644 --- a/pages.zh/common/ag.md +++ b/pages.zh/common/ag.md @@ -1,6 +1,6 @@ # ag -> The Silver Searcher. 类似 ack, 但是更快。 +> The Silver Searcher. 类似 `ack`, 但是更快。 > 更多信息：. - 寻找内容包含"小明"的文件，并列出所在的行数： diff --git a/pages/common/a2ping.md b/pages/common/a2ping.md index 20170f1c8..950910883 100644 --- a/pages/common/a2ping.md +++ b/pages/common/a2ping.md @@ -11,11 +11,11 @@ `a2ping --nocompress {{none|zip|best|flate}} {{path/to/file}}` -- Scan HiResBoundingBox if present (Note: It Defaults to yes): +- Scan HiResBoundingBox if present (defaults to yes): `a2ping --nohires {{path/to/file}}` -- Allow page content below and left of the origin (Note: It defaults to no): +- Allow page content below and left of the origin (defaults to no): `a2ping --below {{path/to/file}}` diff --git a/pages/common/ab.md b/pages/common/ab.md index c67741e61..58caf57c0 100644 --- a/pages/common/ab.md +++ b/pages/common/ab.md @@ -15,10 +15,10 @@ `ab -n {{100}} -T {{application/json}} -p {{path/to/file.json}} {{url}}` -- Use HTTP [K]eep Alive, i.e. perform multiple requests within one HTTP session: +- Use HTTP [k]eep-Alive, i.e. perform multiple requests within one HTTP session: `ab -k {{url}}` -- Set the maximum number of seconds to spend for benchmarking: +- Set the maximum number of seconds ([t]imeout) to spend for benchmarking: `ab -t {{60}} {{url}}` diff --git a/pages/common/abduco.md b/pages/common/abduco.md index 33c7ab8eb..d18dec3b6 100644 --- a/pages/common/abduco.md +++ b/pages/common/abduco.md @@ -7,11 +7,11 @@ `abduco` -- Attach to a session, creating it if it doesn't exist: +- [A]ttach to a session, creating it if it doesn't exist: `abduco -A {{name}} {{bash}}` -- Attach to a session with `dvtm`, creating it if it doesn't exist: +- [A]ttach to a session with `dvtm`, creating it if it doesn't exist: `abduco -A {{name}}` @@ -19,6 +19,6 @@ `Ctrl + \` -- Attach to a session in read-only mode: +- [A]ttach to a session in [r]ead-only mode: `abduco -Ar {{name}}` diff --git a/pages/common/accelerate.md b/pages/common/accelerate.md index dd2305d11..11f100048 100644 --- a/pages/common/accelerate.md +++ b/pages/common/accelerate.md @@ -11,7 +11,7 @@ `accelerate config` -- Print the estimated GPU memory cost of running a huggingface model with different data types: +- Print the estimated GPU memory cost of running a Hugging Face model with different data types: `accelerate estimate-memory {{name/model}}` diff --git a/pages/common/ack.md b/pages/common/ack.md index f63e55af3..1ca3690ec 100644 --- a/pages/common/ack.md +++ b/pages/common/ack.md @@ -1,6 +1,6 @@ # ack -> A search tool like grep, optimized for developers. +> A search tool like `grep`, optimized for developers. > See also: `rg`, which is much faster. > More information: . diff --git a/pages/common/acme.sh.md b/pages/common/acme.sh.md index a875f77d8..ce97b9705 100644 --- a/pages/common/acme.sh.md +++ b/pages/common/acme.sh.md @@ -1,6 +1,6 @@ # acme.sh -> Shell script implementing ACME client protocol, an alternative to certbot. +> Shell script implementing ACME client protocol, an alternative to `certbot`. > See also `acme.sh dns`. > More information: . diff --git a/pages/common/act.md b/pages/common/act.md index 1f4fb45bf..5eb299364 100644 --- a/pages/common/act.md +++ b/pages/common/act.md @@ -3,7 +3,7 @@ > Execute GitHub Actions locally using Docker. > More information: . -- List the available actions: +- [l]ist the available actions: `act -l` @@ -15,18 +15,18 @@ `act {{event_type}}` -- Run a specific action: +- Run a specific [a]ction: `act -a {{action_id}}` -- Do not actually run the actions (i.e. a dry run): +- Do [n]ot actually run the actions (i.e. a dry run): `act -n` -- Show verbose logs: +- Show [v]erbose logs: `act -v` -- Run a specific workflow: +- Run a specific [W]orkflow: `act push -W {{path/to/workflow}}` diff --git a/pages/common/ag.md b/pages/common/ag.md index 902dfecac..854348309 100644 --- a/pages/common/ag.md +++ b/pages/common/ag.md @@ -1,6 +1,6 @@ # ag -> The Silver Searcher. Like ack, but aims to be faster. +> The Silver Searcher. Like `ack`, but aims to be faster. > More information: . - Find files containing "foo", and print the line matches in context: diff --git a/pages/common/age-keygen.md b/pages/common/age-keygen.md index c3cbabd9c..997f7cf9c 100644 --- a/pages/common/age-keygen.md +++ b/pages/common/age-keygen.md @@ -4,7 +4,7 @@ > See `age` for how to encrypt/decrypt files. > More information: . -- Generate a key pair, save it to an unencrypted file and print the public key to `stdout`: +- Generate a key pair, save it to an unencrypted file, and print the public key to `stdout`: `age-keygen --output {{path/to/file}}` diff --git a/pages/common/airdecap-ng.md b/pages/common/airdecap-ng.md index 83c477aa5..fdcabf4ea 100644 --- a/pages/common/airdecap-ng.md +++ b/pages/common/airdecap-ng.md @@ -1,6 +1,6 @@ # airdecap-ng -> Decrypt a WEP, WPA or WPA2 encrypted capture file. +> Decrypt a WEP, WPA, or WPA2 encrypted capture file. > Part of Aircrack-ng network software suite. > More information: . diff --git a/pages/common/alex.md b/pages/common/alex.md index eadc8c5e0..9727a2887 100644 --- a/pages/common/alex.md +++ b/pages/common/alex.md @@ -14,7 +14,7 @@ - Analyze a specific file: -`alex {{textfile.md}}` +`alex {{path/to/file.md}}` - Analyze all Markdown files except `example.md`: diff --git a/pages/linux/shutdown.md b/pages/linux/shutdown.md index e0b0e5be8..aa8021c6e 100644 --- a/pages/linux/shutdown.md +++ b/pages/linux/shutdown.md @@ -3,22 +3,22 @@ > Shutdown and reboot the system. > More information: . -- Power off (halt) immediately: +- Power off ([h]alt) immediately: `shutdown -h now` -- Reboot immediately: +- [r]eboot immediately: `shutdown -r now` -- Reboot in 5 minutes: +- [r]eboot in 5 minutes: `shutdown -r +{{5}} &` -- Shutdown at 1:00 pm (Uses 24h clock): +- Shutdown at 1:00 pm (Uses 24[h] clock): `shutdown -h 13:00` -- Cancel a pending shutdown/reboot operation: +- [c]ancel a pending shutdown/reboot operation: `shutdown -c`