Re-applied fixes from testing datadoc on a use case for PINK.

[jesper-friis]

Description

Re-applied fixes from testing datadoc on a use case for PINK.

Type of change

• Bug fix and code cleanup
• New feature
• Documentation update
• Testing

Checklist for the reviewer

This checklist should be used as a help for the reviewer.

• Is the change limited to one issue?
• Does this PR close the issue?
• Is the code easy to read and understand?
• Do all new feature have an accompanying new test?
• Has the documentation been updated as necessary?
• Is the code properly tested?

[codecov]

Codecov Report

Attention: Patch coverage is 70.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 76.72%. Comparing base (33f1495) to head (4bad7b0).
Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
tripper/dataset/datadoc.py	0.00%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #285      +/-   ##
==========================================
+ Coverage   76.68%   76.72%   +0.04%     
==========================================
  Files          22       22              
  Lines        2415     2415              
==========================================
+ Hits         1852     1853       +1     
+ Misses        563      562       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[francescalb]

There is an extra ´with´ in line 51

[francescalb]

line 301: an --> can

[francescalb]

lien 305: options --> option

[francescalb]

Just a few typo-comments above.

However, I find the order og arguments to datadoc to be a bit unintuitive. Wouldn't it be better to have
datadoc find/add/load and the non-positional arguments?

[jesper-friis]

However, I find the order og arguments to datadoc to be a bit unintuitive. Wouldn't it be better to have datadoc find/add/load and the non-positional arguments?

I do not disagree, but don't know how to improve. datadoc is using argparse sub-commands the standard way. The behaviour should be similar to git. Both for datadoc and git is the general syntax git [GENERAL_OPTIONS...] subcommand [SUBCOMMAND_OPTIONS...]. The only difference is that you seldom use the general options with git (since with git, all connection configurations are inferred from the working dir). But git --git-dir=a.git --work-tree=b -C c status --short is a possible and valid git command.

Or are you thinking about that the help for the add and load sub-commands lists the positional arguments before the options? That is just the choice of how argparse shows its help output. The order of options and positional arguments for the sub-commands are interchangeable.