Skip to content

DOC: warn about --force for dirty repos #370

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.

Sign up for GitHub

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

Open
stsievert wants to merge 1 commit into
base: master
Choose a base branch
from
Open

DOC: warn about --force for dirty repos #370

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion doctr/__main__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,9 @@ def deploy(args, parser):

if not args.force and not on_travis():
parser.error("doctr does not appear to be running on Travis. Use "
"doctr deploy <target-dir> --force to run anyway.")
"doctr deploy <target-dir> --force to run anyway.\n\n"
"WARNING: this will remove any dirty files"
Copy link
Member

@asmeurer asmeurer Aug 3, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about just not mentioning --force at all and also hiding it from the --help output.

)

config = get_config()

Expand Down