Skip to content

[AIRFLOW-XXX] Fix doc of command line interface #3861

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

Closed
XD-DENG wants to merge 1 commit into from
Closed

[AIRFLOW-XXX] Fix doc of command line interface #3861

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: 2 additions & 2 deletions airflow/bin/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1457,7 +1457,7 @@ class CLIFactory(object):
'subdir': Arg(
("-sd", "--subdir"),
"File location or directory from which to look for the dag",
default=settings.DAGS_FOLDER),
default="[AIRFLOW_HOME]/dags"),

@ashb ashb Sep 7, 2018 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Unfortunatley changing this default actually changes the value that will be in args.subdir - so this change would break a lot of things.

It might be possible to change the $AIRFLOW_HOME when rendering the docs, or to change the display of this param?

@kaxil How are the docs built when render then? Would it maybe be worth setting something like export AIRFLOW_HOME=\$AIRFLOW_HOME so that these defaults make sense? (That might well break other things)

@XD-DENG XD-DENG Sep 7, 2018 •
edited
Loading

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

You're right. Didn't realize this.

I would leave this to @kaxil to decide how he would like to fix this (please feel free to close this PR should you're going to fix this separately).

But we do need to fix this. Default: /Users/kaxil/airflow/dags in the documentation is very confusing and misleading to doc readers.

'start_date': Arg(
("-s", "--start_date"), "Override start_date YYYY-MM-DD",
type=parsedate),
Expand Down Expand Up @@ -1874,7 +1874,7 @@ class CLIFactory(object):
"If reset_dag_run option is used,"
" backfill will first prompt users whether airflow "
"should clear all the previous dag_run and task_instances "
"within the backfill date range."
"within the backfill date range. "
"If rerun_failed_tasks is used, backfill "
"will auto re-run the previous failed task instances"
" within the backfill date range.",
Expand Down