slipenkomk/sequoia-sq
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve rendering of the user interface guidelines in API docs.

Browse Source
This commit is contained in:
Justus Winter 2024-01-17 13:36:43 +01:00
parent 10fd523fc4
commit 9394f6292d
No known key found for this signature in database
GPG Key ID: 686F55B4AB2B3386
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/cli/mod.rs
View File

@ -47,16 +47,16 @@
///
/// - The first line of the about texts MUST NOT end in a period.
///
/// - To define terms, enclose them in double quotes: "certificate".
/// - To define terms, enclose them in double quotes: `"certificate"`.
///
/// - To include inline code fragments, like options or other
/// subcommands, use back ticks: `--foo` or `sq foo bar`.
///
/// - When referring to options, do not include the VALUENAME.
/// - When referring to options, do not include the `VALUENAME`.
///
/// - Enclose URLs in angle brackets: <https://example.org>.
/// - Enclose URLs in angle brackets: `<https://example.org>`.
///
/// - Use a spaced en dash for parenthetical statements (" – ").
/// - Use a spaced en dash for parenthetical statements (` – `).
///
/// ## Examples
///
@ -65,7 +65,7 @@
/// - Every example MUST have a brief description.
///
/// - Examples SHOULD be short and to the point, they SHOULD NOT
/// include unnecessary options (like --keyring).
/// include unnecessary options (like `--keyring`).
///
/// - Examples MUST use single quotes where necessary.
///