open-contracting / spoonbill

A library and command-line tool to convert OCDS data from JSON to Excel/CSV
https://spoonbill.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
7 stars 2 forks source link

Rename CLI options #111

Open jpmckinney opened 3 years ago

jpmckinney commented 3 years ago

Some option names could perhaps be improved: https://open-contracting.github.io/spoonbill/cli.html

@sabahfromlondon @yolile What do you think of?

I think all other option names are clear (most options are for columns, so I think okay to not have a -columns suffix).

sabahfromlondon commented 3 years ago

@jpmckinney I like the suggested changes a lot. split-at NUM for instance is much clearer.

The only suggestion I have is that maybe instead of initial tables use the wording root-tables?

yolile commented 3 years ago

I agree with @sabahfromlondon, and another option instead of initial tables is "parent" tables, which makes sense as we are using "child-tables" later.

jpmckinney commented 3 years ago

I'm happy with --only-root-tables. --only-parent-tables could be confusing, because contracts_items is a parent table to contracts_items_class, but it is not an initial/root table.

jpmckinney commented 3 years ago

@sorenabell This is the sort of small change that I am happy to commit on my own, so that Quinta can focus on the more challenging and time-consuming changes.

For this kind of change, do you prefer that I assign the PR for review by Quinta, or just merge it myself?

sorenabell commented 3 years ago

@jpmckinney please assign PR review for @yshalenyk nevertheless, just for us to be in the loop.