diff: document --hide-missing option#1758
Conversation
There was a problem hiding this comment.
Thanks for this @pmrowla
Other than the comments above, it's kind of confusing to mix the concept of status with diff. Are these the same states that dvc status handles for example? The explanation can get complicated quickly. It would be best to keep that term out of the text in this ref. if possible
- BTW we should remove it from the
--show-mdoption desc. probably. I can do that later...
|
Still thinking about how to best re-word the docs for this without mixing/confusing |
* move details to the options section * avoid using the term `status` to avoid confusion with `dvc status`
jorgeorpinel
temporarily deployed
to
dvc-landing-diff-hide-m-qfjklq
| Options `--show-json` and `--show-hash` can be used to modify format and details | ||
| of the output produced. See the [Options](#options) and [Examples](#examples) | ||
| sections below for more details. | ||
| Options `--show-json`, `--show-hash` and `--hide-missing` can be used to modify |
There was a problem hiding this comment.
| Options `--show-json`, `--show-hash` and `--hide-missing` can be used to modify | |
| Options `--show-json`, `--show-hash`, and `--hide-missing` can be used to modify |
May break formatting
There was a problem hiding this comment.
Not sure we want to mention --hide-missing here though. Maybe just
--show-jsonand--show-hashcan be used to modify the format of the output
There was a problem hiding this comment.
reverted these changes to just omit --hide-missing from this part of the dvc diff docs
There was a problem hiding this comment.
Thanks. We probably should say "and details" now though...
- I'll update it separately.
jorgeorpinel
left a comment
jorgeorpinel
left a comment
There was a problem hiding this comment.
I think we've got it now. Thanks for bearing with me @pmrowla
per pending items in #1758
* guide: use back quotes in headers per #1735 (comment) * guide: use ```yaml instead of yml (consistency) * guide: capitalize bullet list * intsall: remove unnecessary line in Linux/snap * guide: make H3s into expandable sections in x data docs per #1735 (comment) * cmd: cosmetic updates to cache.{type} config option descriptions * cmd: std option descs in diff per pending items in #1758 * cmd: small impro to diff * term: review usage of SCM * cmd: remove redundant wording in add * cmd: fix format and typo intro by #1779
3 participants
❗ 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 choose 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. 🙏
Documentation changes for treeverse/dvc#4530