doc: show-md on params/metrics diff

[skshetry]

You may disregard these recommendations if you used the Edit on GitHub button from dvc.org to improve a doc in place.

❗ Please read the guidelines in the Contributing to the Documentation list if you make any substantial changes to the documentation or JS engine.

🐛 Please make sure to mention Fix #issue (if applicable) in the description of the PR. This causes GitHub to close it automatically when the PR is merged.

Please chose to allow us to edit your branch when creating the PR.

Thank you for the contribution - we'll try to review it as soon as possible. 🙏

Implemented on iterative/dvc#3757

[jorgeorpinel]

Thanks @skshetry. Can you please link to the core repo PR so we know whether or when it's merged? Bc I'm not seeing this behavior on dvc master branch yet.

[jorgeorpinel]

Is this the actual order in which it's printed? I don't see this output in the core repo master branch yet. Thanks

[skshetry]

Is this the actual order in which it's printed?

Yes, that's the order.

$ dvc metrics diff -h
usage: dvc metrics diff [-h] [-q | -v] [--targets [<paths> [<paths> ...]]] [-R] [--all] [--show-json] [--show-md]
                        [a_rev] [b_rev]

Show changes in metrics between commits
Documentation: <https://man.dvc.org/metrics/diff>

positional arguments:
  a_rev                 Old Git commit to compare (defaults to HEAD)
  b_rev                 New Git commit to compare (defaults to the current workspace)

optional arguments:
  -h, --help            show this help message and exit
  -q, --quiet           Be quiet.
  -v, --verbose         Be verbose.
  --targets [<paths> [<paths> ...]]
                        Metric files or directories (see -R) to show diff for. Shows diff for all metric files by default.
  -R, --recursive       If any target is a directory, recursively search and process metric files.
  --all                 Show unchanged metrics as well.
  --show-json           Show output in JSON format.
  --show-md             Show tabulated output in the Markdown format (GFM).

Note that we still need to readjust the docs for the -t and -x on the metrics. But, I have tried to keep the order for all dvc {metrics,params} diff.

[jorgeorpinel]

Looks like you're missing [--all] though.

[jorgeorpinel]

I'll take care of it.

[skshetry]

The heading formats got affected by the change. Previously it was centered, it's left aligned now.

[shcheklein]

@skshetry would be great to update bash/zsh scripts as well.

[skshetry]

@shcheklein, I have updated zsh/bash autocompletion scripts.