Skip to content
This repository has been archived by the owner on Feb 28, 2024. It is now read-only.

READ-ADD: standardize boolean config options and help messages #472

Open
volkfox opened this issue Aug 22, 2022 · 0 comments
Open

READ-ADD: standardize boolean config options and help messages #472

volkfox opened this issue Aug 22, 2022 · 0 comments
Labels
A: docs Area: user documentation cosmetic

Comments

@volkfox
Copy link
Contributor

volkfox commented Aug 22, 2022

Currently we have some discrepancies between the documentation and command behavior:

  1. Command summary still mentions `add-storage --read-add ' as a valid construct
  2. Various documentation parts mention --read-add true and --read-add = true without distinction:
-a {true,false}, --read-add {true,false}

Storage location registered with --read-add=true must have write-access to allow new files to be added.
  1. Built-in help does not specify that READ_ADD is a boolean flag:
ldb add-storage ~/Downloads/a1/ --read-add 
error: ldb add-storage: error: argument -a/--read-add: expected one argument

  -a READ_ADD, --read-add READ_ADD
                        Use this location for adding objects

We need to have a bit more consistency on these constructs.
Suggestions:

(1) Document that --read-add true or --read-add = true are the same and mutually replaceable (are they?)
(2) Update the built-in help
(3) For boolean arguments, assume TRUE to be the default, so --read-add is the same as --read-add true (doable?)

@volkfox volkfox added A: docs Area: user documentation cosmetic labels Aug 22, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A: docs Area: user documentation cosmetic
Projects
None yet
Development

No branches or pull requests

1 participant