question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

there's ambiguity between the terms "stage" and "stage file"

See original GitHub issue

(Emanating from #321)

  • Directly affects dvc add, dvc import, and dvc run command refs.
  • Indirectly affects many other docs where these terms are used. See for example the description of the dvc lock cmd ref.
  • Look also double check the usage of the term “step(s)” (which should be stages). Related: #448

Definitions

From @mroutis:

You can say that stage is a node on a pipeline, and pipelines are the weakly-connected-component subgraphs of a DAG.

Internally, on the source code, stage is whatever is related to a file ending with .dvc (DVC-file or “stage file”). It doesn’t imply a “command” or an “action”, so dvc add will create a .dvc file describing the path and checksum of a file, without any instructions to generate such output

Aproach

From @shcheklein:

for the documentation we should be thinking from the user perspective first. For example, it means that stage term can be confusing for ppl who are using it to manage data

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:5 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
shchekleincommented, Jun 12, 2019

@jorgeorpinel I don’t think it’s a problem at all. It makes sense that on a code level we have a way deeper understanding and can use “advanced” terminology. From the user perspective it should be simple, it should be resonating with their needs, etc. We are not optimizing DOCs to be “compatible” with DVC code conventions.

0reactions
jorgeorpinelcommented, Jun 27, 2019

I think this is resolved now. Both terms “stage” and “stage file” still exist when appropriate, especially in pipeline-related docs.

Read more comments on GitHub >

github_iconTop Results From Across the Web

How Courts Interpret Ambiguous Contracts
There is a general rule that a court will construe ambiguous contract terms against the drafter of the agreement. But this rule only...
Read more >
Ambiguous Contracts - LegalMatch
Because there are many different factors that go into a contract, even well-written contracts can sometimes contain ambiguous terms.
Read more >
The Ambiguity Question | Elements of Contract Interpretation
In the first instance, the court needs to determine only whether the contract is ambiguous. It can leave proof of the document's meaning...
Read more >
Contra Proferentem Rule Definition - Investopedia
The contra proferentem rule is a legal doctrine stipulating that a party be deemed at fault if it has created or introduced an...
Read more >
Contract Interpretation and the Parol Evidence Rule
This Article addresses the following seven issues: (1) the two types of latent ambiguity; (2) the many definitions of “parol evidence”; (3) the...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found