From: rinpatch <rinpatch@sdf.org>
Date: Thu, 3 Oct 2019 05:51:57 +0000 (+0300)
Subject: Improve styling of CLI tasks
X-Git-Url: https://git.squeep.com/?a=commitdiff_plain;h=a54739a530a291483893b0c334d35fb893026a2a;p=akkoma

Improve styling of CLI tasks
---

diff --git a/docs/administration/CLI_tasks/digest.md b/docs/administration/CLI_tasks/digest.md
index 89b3ed237..547702031 100644
--- a/docs/administration/CLI_tasks/digest.md
+++ b/docs/administration/CLI_tasks/digest.md
@@ -1,14 +1,12 @@
 # Managing digest emails
 Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl digest` and in case of source installs it's `mix pleroma.digest`.
 
-## `test`
+## Send digest email since given date (user registration date by default) ignoring user activity status.
 
 ```sh
-$PREFIX test <nickname> <since_date>
+$PREFIX test <nickname> [<since_date>]
 ```
 
-Send digest email since given date (user registration date by default) ignoring user activity status.
-
 Example: 
 ```sh
 $PREFIX test donaldtheduck 2019-05-20
diff --git a/docs/administration/CLI_tasks/emoji.md b/docs/administration/CLI_tasks/emoji.md
index 39216a897..d274953eb 100644
--- a/docs/administration/CLI_tasks/emoji.md
+++ b/docs/administration/CLI_tasks/emoji.md
@@ -2,31 +2,28 @@
 
 Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl emoji` and in case of source installs it's `mix pleroma.emoji`.
 
-## `ls-packs`
+## Lists the emoji packs and metadata specified in the manifest.
 
 ```sh
-$PREFIX ls-packs [OPTION...]
+$PREFIX ls-packs [<options>]
 ```
 
-Lists the emoji packs and metadata specified in the manifest.
-
 ### Options
 - `-m, --manifest PATH/URL` - path to a custom manifest, it can either be an URL starting with `http`, in that case the manifest will be fetched from that address, or a local path
 
-## `get-packs`
+## Fetch, verify and install the specified packs from the manifest into `STATIC-DIR/emoji/PACK-NAME`
 ```sh
-$PREFIX get-packs [OPTION...] PACKS
+$PREFIX get-packs [<options>] <packs>
 ```
-Fetches, verifies and installs the specified PACKS from the manifest into the `STATIC-DIR/emoji/PACK-NAME`
 
 ### Options
 - `-m, --manifest PATH/URL` - same as [`ls-packs`](#ls-packs)
 
-## `gen-pack`
+## Create a new manifest entry and a file list from the specified remote pack file
 ```sh
 $PREFIX gen-pack PACK-URL
 ```
-Creates a new manifest entry and a file list from the specified remote pack file. Currently, only .zip archives are recognized as remote pack files and packs are therefore assumed to be zip archives. This command is intended to run interactively and will first ask you some basic questions about the pack, then download the remote file and generate an SHA256 checksum for it, then generate an emoji file list for you. 
+Currently, only .zip archives are recognized as remote pack files and packs are therefore assumed to be zip archives. This command is intended to run interactively and will first ask you some basic questions about the pack, then download the remote file and generate an SHA256 checksum for it, then generate an emoji file list for you. 
 
   The manifest entry will either be written to a newly created `index.json` file or appended to the existing one, *replacing* the old pack with the same name if it was in the file previously.