openSUSE / agama / 9267962374

72%

push

github

Better CLI documentation (#1269)

The documentation for Agama's CLI is rather poor, making it hard to use.
The goal of this pull request is to improve such documentation by:

* Expanding the existing descriptions.
* Unifying the style to make it more consistent.
* Adding the missing documentation.

<details>
<summary>agama auth --help</summary>

![Captura desde 2024-05-28
09-50-22](https://github.com/openSUSE/agama/assets/15836/96d7ceab-37ba-4f19-afe0-7e0cf9ddd0ce)
</details>

## Out of scope

* This PR does not adapt the `profile` command because we are actively
working on it (see #1270).
* I did not update the changelog. We will do it once
https://trello.com/c/V6ML7csV/3686-5-improve-the-cli is finished.

1987 of 2868 branches covered (69.28%)

Branch coverage included in aggregate %.

18687 of 26501 relevant lines covered (70.51%)

31.77 hits per line