diff/metics diff: update argument descriptions, et al. #3244

jorgeorpinel · 2020-01-27T19:46:05Z

to match iterative/dvc.org#933

❗ Have you followed the guidelines in the Contributing to DVC list?
📖 Check this box if this PR does not require documentation updates, or if it does and you have created a separate PR in dvc.org with such updates (or at least opened an issue about it in that repo). Please link below to your PR (or issue) in the dvc.org repo.
❌ Have you checked DeepSource, CodeClimate, and other sanity checks below? We consider their findings recommendatory and don't expect everything to be addressed. Please review them carefully and fix those that actually improve code or fix bugs.

to match iterative/dvc.org#933

dvc/command/diff.py

per iterative/dvc.org/pull/933

setup.py

ghost · 2020-01-30T15:46:19Z

@jorgeorpinel , looks like you've change the old diff implementation, I will include your changes in my PR.

ghost

@jorgeorpinel , the new implementation of dvc diff got merged, please update your PR accordingly

per #3244 (review)

jorgeorpinel · 2020-01-30T18:27:03Z

looks like you've change the old diff implementation

@MrOutis I changed just some of the help output stings, but I'm merging with master now and (mostly) preserved your text. Please check again 🙂

per iterative/dvc/pull/3244

jorgeorpinel

Self review below (1 comment). Also:

Update autocomplete scripts per diff/metrics diff output updates.

jorgeorpinel · 2020-01-30T20:08:06Z

dvc/remote/base.py

-                desc="Computing hashes (only done once)",
+                desc="Computing file checksum(s) (only done once)",


Should probably revert per iterative/dvc.org#933 (review)

OK I reverted this and applied "hash" terminology as much as possible to the whole file, as well as a few others in 5019fe1. If this commit is acceptable, I can update all the other instances (there's less than 70, in 19 files.
Or I can extract further changes on this to a separate issue/PR. Cc @MrOutis @efiop

dvc/command/diff.py

ghost

cool, @jorgeorpinel 👍

just left a comment where I didn't understand your change, but I guess it is not that crucial to stop this from being merged

per #3244 (review)

dvc/command/commit.py

dvc/command/diff.py

per #3244 (review)

per iterative/dvc#3244 (review)

efiop · 2020-02-02T23:56:01Z

dvc/command/diff.py

@@ -134,17 +133,17 @@ def add_parser(subparsers, parent_parser):
    diff_parser.add_argument(
        "a_ref",


We need to rename ref -> rev in args too. Can do after this PR is merged.

efiop · 2020-02-02T23:57:04Z

dvc/version.py

@@ -11,7 +11,7 @@


 def _generate_version(base_version):
-    """Generate a version with information about the git repository"""
+    """Generate a version with information about the Git repository."""


To be honest, not a big fan of such changes in the code. It only pollutes the history and doesn't provide any value.

I'm used to making copy edits on docs all the time so this is kind of automatic for me but whatever policies you tell me for the core repo I'll abide to the best of my ability. Personally I don't understand the problem of history pollution but I guess it complicates your release management? Anyway, I'll follow your lead on these things of course.

dvc/remote/base.py

efiop · 2020-02-03T00:00:06Z

dvc/command/diff.py

@@ -156,7 +155,7 @@ def add_parser(subparsers, parent_parser):
    )
    diff_parser.add_argument(
        "--checksums",


Will need to rename checksum -> hash in the whole code base. Need to do that in a sync way to not introduce more confusion for developers and users.

For the record, this question has been extracted to #3311

efiop · 2020-02-03T00:15:45Z

Alright, I'm not happy about the mix of things here, but let's merge and move on. Please try to not dilute the focus of your PRs. Create new ones if you decide to change something else that is not related. That way it is easier to review and merge, so we could all move faster.

* add docs for dvc metrics diff * nav: add `metrics diff` to sidebar * cmd ref: typos in `metrics diff` * cmd ref: rewrite `metrics diff` ref and and review related concepts throughout docs e.g. "Git reference", "working tree" * cmd ref: update descs, review options, link all metrics subcmds addresses #933 (review) as well as #933 (review) and #933 (review) * cmd ref: update cmd argument descriptions for `diff` and `metics diff` * metrics diff: big terminology review around the intro of this new command per #933 (review) et al. * term: review usage of "hash", "commit hash", "SHA", and "MD5" per #933 (review) * term: rewrite definition of "workspace" per #933 (review) * cmd ref: change link from `metrics diff` options to `metrics show` per #933 (comment) * cmd ref: update example in `dvc metrics diff` and similar ones per #933 (review) * cmd ref: simplify dvc gc -a option per #933 (review) and #933 (review) * cmd ref: use "reference" more than "revision" in diff per #933 (review) * cmd ref: link term "revision" in diff and `metrics diff` also per #933 (review) * term: put Git ref exapmles before term and link per #933 (review) * cmd ref: friendlier explanation of "tip of default branch" per #933 (review) * cmd ref: use tag name instead of term "the revision" per #933 (review) * term: revert some "revision"->"reference" changes, and related simplifications per #933 (review) * cmd ref: review desc. of `-a` options throughout refs * cmd ref: update diff params per iterative/dvc/pull/3244 * cmd ref: update notes around moving/static Git refs in import and update per #933 (review) * revert workspace glossary entry per #933 (review) * tutorial: use full name of Deep Dive Tutorial in title and links per #933 (review) * user-guide: undo change on "binary" literal for analytics example per #933 (review) * use-cases: avoid term "revision" in data-registries per #933 (review) * term: revert "hash"->"checksum" in this PR per #933 (comment) * cmd ref: "revision"->"commit" in get ref per #933 (review) * cmd ref: use correct tag names in checkout examples and double check they still work per #933 (review) * diff: remove backquotes adound "HEAD" same as in core repo per iterative/dvc#3244 (review) * cmd ref: don't use link to git reference doc per #933 (comment) * cmd ref: don't use term "revision" in diff, prefer "commit" per #933 (review) * cmd ref: no need for word "specific" (or "SHA") in get/import per #933 (review) * cmd ref: update "project"->"workspace" term and example intros in `dvc install` per #933 (review) * docs: 2 misc updates per #933 (review) and #933 (review) * tutorials: update model->"data or model" per #933 (review) et al. * cmd ref: fixed link to `metrics diff` and updated mention of it in `metrics show` per #933 (review) and #933 (review) and #933 (review) * get-started: typo in pipelines chapter * cmd ref: rewrite paragraph about fixed revision import stages in `update` per #933 (review) * cmd ref: rewrite p about `repro` rewriting artifacts in cache per #933 (review) * cmd ref: rephrase and split p about what to compare and about targets in `status` per #933 (review) * cmd ref: reorg last part of repro desc * cmd ref: restore `git tag` sample output in checkout examples per #933 (review) and #961 (comment) * cmd ref: small rewording around tag names * cmd ref: `metrics diff` and `diff` intro updates per #933 (review) and #933 (review) * term: use "version" instead of "revision" in `import` cmd ref per #933 (comment) * cmd ref: updates to `metrics diff` (and `diff`) descriptions per https://dvc.org/doc/command-reference/status and #933 (review) and #933 (review) * cmd ref: change "ref" -> "rev" per iterative/dvc/pull/3299 and #933 (review) * cmd ref: "revision"->"version" in a couple more docs per #933 (review) * cmd ref: simplify note about `metrics diff` in `metrics show` per #933 (review) * cmd ref: use descriptive exampe-get-started repo tags in `get` examples per #933 (review) * term: "commit hash"->"commit SHA hash" to match #962 but may change the decision in that other PR. * cmd ref: improve -a adn -c option descs per #933 (review) * cmd ref: remove p about --targets option in metrics diff per #933 (review) * cmd ref: rewrite pa bout fixed revisions/re-importing in `update` per #933 (review) * tutorials: use and instead of data "or" models in versioning tut per #933 (review) and #933 (review) * user-guide: restore bullet about `git` in analytics per #933 (review) * you don't usually merge tags per #933 (review) * term: don't use "version of repo/project" when referring to commits per #933 (comment) * cmd ref: simlpify note about metrics diff in metrics show per #933 (review) * cmd ref: and->and/or in checkout sample of versioning tut per #933 (review) * user-guide: updated analytics details per #933 (review) * cmd ref: restore simpler wording about status -aT desc per #933 (review) * cmd ref: correct (again) the short desc for diff and metrics diff per #933 (comment) Co-authored-by: Jorge Orpinel <jorgeorpinel@users.noreply.github.com>

…ext) (#962) * add docs for dvc metrics diff * nav: add `metrics diff` to sidebar * cmd ref: typos in `metrics diff` * cmd ref: rewrite `metrics diff` ref and and review related concepts throughout docs e.g. "Git reference", "working tree" * cmd ref: update descs, review options, link all metrics subcmds addresses #933 (review) as well as #933 (review) and #933 (review) * cmd ref: update cmd argument descriptions for `diff` and `metics diff` * metrics diff: big terminology review around the intro of this new command per #933 (review) et al. * term: review usage of "hash", "commit hash", "SHA", and "MD5" per #933 (review) * term: rewrite definition of "workspace" per #933 (review) * cmd ref: change link from `metrics diff` options to `metrics show` per #933 (comment) * cmd ref: update example in `dvc metrics diff` and similar ones per #933 (review) * cmd ref: simplify dvc gc -a option per #933 (review) and #933 (review) * cmd ref: use "reference" more than "revision" in diff per #933 (review) * cmd ref: link term "revision" in diff and `metrics diff` also per #933 (review) * term: put Git ref exapmles before term and link per #933 (review) * cmd ref: friendlier explanation of "tip of default branch" per #933 (review) * cmd ref: use tag name instead of term "the revision" per #933 (review) * term: revert some "revision"->"reference" changes, and related simplifications per #933 (review) * cmd ref: review desc. of `-a` options throughout refs * cmd ref: update diff params per iterative/dvc/pull/3244 * cmd ref: update notes around moving/static Git refs in import and update per #933 (review) * revert workspace glossary entry per #933 (review) * tutorial: use full name of Deep Dive Tutorial in title and links per #933 (review) * user-guide: undo change on "binary" literal for analytics example per #933 (review) * use-cases: avoid term "revision" in data-registries per #933 (review) * term: avoid "checksum" in favor of file "hash" value per #933 (review) * term: SHA hash -> hash (Git commit context) per #962 (comment) Co-authored-by: Ruslan Kuprieiev <kupruser@gmail.com>

jorgeorpinel · 2020-02-14T06:40:54Z

Please try to not dilute the focus of your PRs

Understood, sorry about that!

diff/metics diff: update argument descriptions

bfa1d3e

to match iterative/dvc.org#933

jorgeorpinel commented Jan 27, 2020

View reviewed changes

dvc/command/diff.py Outdated Show resolved Hide resolved

jorgeorpinel mentioned this pull request Jan 27, 2020

add docs for dvc metrics diff iterative/dvc.org#933

Merged

jorgeorpinel added 4 commits January 29, 2020 00:08

diff: remve unused DIFF_HELP

2430cb5

metrics diff: update help desc.

b10057a

per iterative/dvc.org/pull/933

term: review usage of "version" in strings

b3ff72c

term: review "revision", "reference", and "hash", "SHA" terms

d0139a7

jorgeorpinel marked this pull request as ready for review January 29, 2020 06:39

jorgeorpinel changed the title ~~diff/metics diff: update argument descriptions~~ diff/metics diff: update argument descriptions, et al. Jan 29, 2020

Update Dmitry's email address )

1672cdf

jorgeorpinel commented Jan 29, 2020

View reviewed changes

setup.py Outdated Show resolved Hide resolved

jorgeorpinel mentioned this pull request Jan 30, 2020

term: replace (Git) "reference" for "revision" or "commit" #3245

Closed

ghost suggested changes Jan 30, 2020

View reviewed changes

jorgeorpinel added 3 commits January 30, 2020 12:24

Merge branch 'master' of github.com:iterative/dvc

aa849ab

metrics diff: use same param desc as in simple diff

4403d66

Update Dmitry's email address in several places

039f196

per #3244 (review)

jorgeorpinel requested a review from a user January 30, 2020 18:27

jorgeorpinel added a commit to efiop/dvc.org that referenced this pull request Jan 30, 2020

cmd ref: update diff params

c5dbb96

per iterative/dvc/pull/3244

jorgeorpinel commented Jan 30, 2020

View reviewed changes

ghost reviewed Jan 30, 2020

View reviewed changes

dvc/command/diff.py Outdated Show resolved Hide resolved

ghost approved these changes Jan 30, 2020

View reviewed changes

jorgeorpinel added 3 commits January 30, 2020 18:13

term: use "hash" instead of "checksum" in a few files

5019fe1

per #3244 (review)

scripts: update autocomplete per diff changes

611c1d6

per #3244 (review)

diff/metrics diff: simplify b_ref desc

6984546

per #3244 (review)

jorgeorpinel requested review from a user and efiop January 31, 2020 00:26

ghost reviewed Jan 31, 2020

View reviewed changes

dvc/command/commit.py Show resolved Hide resolved

ghost reviewed Jan 31, 2020

View reviewed changes

dvc/command/diff.py Outdated Show resolved Hide resolved

jorgeorpinel added 2 commits January 31, 2020 19:59

remove unnecessary line from PR template

e70d5fd

diff: remove backquotes around "HEAD"

c27f6ef

per #3244 (review)

jorgeorpinel added a commit to efiop/dvc.org that referenced this pull request Feb 1, 2020

diff: remove backquotes adound "HEAD" same as in core repo

cc82aca

per iterative/dvc#3244 (review)

iterative deleted a comment Feb 1, 2020

jorgeorpinel requested a review from a user February 1, 2020 02:14

weekly-digest bot mentioned this pull request Feb 2, 2020

Weekly Digest (26 January, 2020 - 2 February, 2020) #3272

Closed

efiop reviewed Feb 2, 2020

View reviewed changes

dvc/remote/base.py Show resolved Hide resolved

efiop reviewed Feb 3, 2020

View reviewed changes

efiop merged commit de1f67a into iterative:master Feb 3, 2020

weekly-digest bot mentioned this pull request Feb 9, 2020

Weekly Digest (2 February, 2020 - 9 February, 2020) #3289

Closed

weekly-digest bot mentioned this pull request Feb 16, 2020

Weekly Digest (9 February, 2020 - 16 February, 2020) iterative/dvc.org#1002

Closed

casperdcl mentioned this pull request Jul 10, 2020

blog: shtab completion iterative/dvc.org#1505

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

diff/metics diff: update argument descriptions, et al. #3244

diff/metics diff: update argument descriptions, et al. #3244

jorgeorpinel commented Jan 27, 2020 •

edited

Loading

ghost commented Jan 30, 2020

ghost left a comment

jorgeorpinel commented Jan 30, 2020

jorgeorpinel left a comment •

edited

Loading

jorgeorpinel Jan 30, 2020

jorgeorpinel Jan 31, 2020

ghost left a comment

efiop Feb 2, 2020

efiop Feb 2, 2020

jorgeorpinel Feb 14, 2020

efiop Feb 3, 2020

jorgeorpinel Feb 14, 2020

efiop commented Feb 3, 2020 •

edited

Loading

jorgeorpinel commented Feb 14, 2020

		desc="Computing hashes (only done once)",
		desc="Computing file checksum(s) (only done once)",

		@@ -134,17 +133,17 @@ def add_parser(subparsers, parent_parser):
		diff_parser.add_argument(
		"a_ref",

diff/metics diff: update argument descriptions, et al. #3244

diff/metics diff: update argument descriptions, et al. #3244

Conversation

jorgeorpinel commented Jan 27, 2020 • edited Loading

ghost commented Jan 30, 2020

ghost left a comment

Choose a reason for hiding this comment

jorgeorpinel commented Jan 30, 2020

jorgeorpinel left a comment • edited Loading

Choose a reason for hiding this comment

jorgeorpinel Jan 30, 2020

Choose a reason for hiding this comment

jorgeorpinel Jan 31, 2020

Choose a reason for hiding this comment

ghost left a comment

Choose a reason for hiding this comment

efiop Feb 2, 2020

Choose a reason for hiding this comment

efiop Feb 2, 2020

Choose a reason for hiding this comment

jorgeorpinel Feb 14, 2020

Choose a reason for hiding this comment

efiop Feb 3, 2020

Choose a reason for hiding this comment

jorgeorpinel Feb 14, 2020

Choose a reason for hiding this comment

efiop commented Feb 3, 2020 • edited Loading

jorgeorpinel commented Feb 14, 2020

jorgeorpinel commented Jan 27, 2020 •

edited

Loading

jorgeorpinel left a comment •

edited

Loading

efiop commented Feb 3, 2020 •

edited

Loading