mab122
/
radicle-heartwood-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

cli: document `rad inbox` further 

The documentation for `rad inbox show` and `rad inbox clear` were
missing.

Add documentation into the help message for both.

Signed-off-by: Fintan Halpenny <fintan.halpenny@gmail.com>
X-Clacks-Overhead: GNU Terry Pratchett
This commit is contained in:
Fintan Halpenny 2024-02-07 14:44:08 +00:00 committed by cloudhead
parent b6e1385e39
commit 50833d88d9
No known key found for this signature in database
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
radicle-cli/src/commands/inbox.rs
View File

@ -29,12 +29,19 @@ Usage
rad inbox [<option>...]
rad inbox list [<option>...]
rad inbox show <id> [<option>...]
rad inbox clear [<option>...]
By default, this command lists all items in your inbox.
If your working directory is a Radicle repository, it only shows item
belonging to this repository, unless `--all` is used.
The `rad inbox show` command takes a notification ID (which can be found in
the `list` command) and displays the information related to that
notification. This will mark the notification as read.
The `rad inbox clear` command will delete all notifications in the inbox.
Options
--all Operate on all repositories