-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
term: replace 'DVC-file' and 'stage file' with correct terms (#3960) #5280
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR, just a few minor suggestions.
Also, this needs a rebase now after some of the changes in master.
dvc/dvcfile.py
Outdated
@@ -65,7 +65,7 @@ def is_lock_file(path): | |||
def check_dvc_filename(path): | |||
if not is_valid_filename(path): | |||
raise StageFileBadNameError( | |||
"bad DVC-file name '{}'. DVC-files should be named " | |||
"bad DVC file name '{}'. DVC files should be named " | |||
"'Dvcfile' or have a '.dvc' suffix (e.g. '{}.dvc').".format( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can get rid of the Dvcfile
part of this error message entirely since we are completely dropping single-stage support in 2.0?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would leave it as it is for now. Later it can be changed closely to 2.0. Anyway, I'm not so informed about 2.0 specific, so it could be difficultly to me to change the message.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The current master branch is for 2.0 so it is safe to change it. The message should be something like:
bad DVC file name '{}'. DVC files should be named '{PIPELINE_FILE}' or have a '.dvc' suffix (e.g. '{}.dvc')
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Internally, outputs and dependencies apply to both pipeline (dvc.yaml
) outputs and data files (.dvc
) so there's a few places we should still be using the generic "DVC file"
hey @DiPaolo, any updates on this? |
@pmrowla I've pushed an update. |
Thanks for the PR! |
Fixes #3960
❗ I have followed the Contributing to DVC checklist.
📖 If this PR requires documentation updates, I have created a separate PR (or issue, at least) in dvc.org and linked it here.
Documentation on dvc.org was already updated before.
Thank you for the contribution - we'll try to review it as soon as possible. 🙏