[
https://issues.apache.org/jira/browse/AIRFLOW-2948?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16590346#comment-16590346
]
ASF GitHub Bot commented on AIRFLOW-2948:
-----------------------------------------
XD-DENG opened a new pull request #3793: [AIRFLOW-2948] Arg check & better doc
- SSHOperator & SFTPOperator
URL: https://github.com/apache/incubator-airflow/pull/3793
Make sure you have checked _all_ steps below.
### Jira
- [x] My PR addresses the following [Airflow
Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references
them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- https://issues.apache.org/jira/browse/AIRFLOW-2948
- In case you are fixing a typo in the documentation you can prepend your
commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
### Description
- [x] Here are some details about my PR, including screenshots of any UI
changes:
There may be different combinations of arguments, and some processings are
being done 'silently', while users may not be fully aware of them.
For example
- User only needs to provide either `ssh_hook` or `ssh_conn_id`, while this
is not clear in doc
- if both provided, `ssh_conn_id` will be ignored.
- if `remote_host` is provided, it will replace the `remote_host` which
wasndefined in `ssh_hook` or predefined in the connection of `ssh_conn_id`
These should be documented clearly to ensure it's transparent to the users.
log.info() should also be used to remind users and provide clear logs.
### Tests
- [ ] My PR adds the following unit tests __OR__ does not need testing for
this extremely good reason:
### Commits
- [ ] My commits all reference Jira issues in their subject lines, and I
have squashed multiple commits if they address the same issue. In addition, my
commits follow the guidelines from "[How to write a good git commit
message](http://chris.beams.io/posts/git-commit/)":
1. Subject is separated from body by a blank line
1. Subject is limited to 50 characters (not including Jira issue reference)
1. Subject does not end with a period
1. Subject uses the imperative mood ("add", not "adding")
1. Body wraps at 72 characters
1. Body explains "what" and "why", not "how"
### Documentation
- [ ] In case of new functionality, my PR adds documentation that describes
how to use it.
- When adding new operators/hooks/sensors, the autoclass documentation
generation needs to be added.
### Code Quality
- [x] Passes `git diff upstream/master -u -- "*.py" | flake8 --diff`
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
> Arg checking & better doc for SSHOperator and SFTPOperator
> ----------------------------------------------------------
>
> Key: AIRFLOW-2948
> URL: https://issues.apache.org/jira/browse/AIRFLOW-2948
> Project: Apache Airflow
> Issue Type: Improvement
> Components: operators
> Reporter: Xiaodong DENG
> Assignee: Xiaodong DENG
> Priority: Minor
>
> There may be different combinations of arguments, and some processings are
> being done 'silently', while users may not be fully aware of them.
>
> For example
> - User only needs to provide either `ssh_hook` or `ssh_conn_id`, while this
> is not clear in doc
> - if both provided, `ssh_conn_id` will be ignored.
> - if `remote_host` is provided, it will replace the `remote_host` which
> wasndefined in `ssh_hook` or predefined in the connection of `ssh_conn_id`
>
> These should be documented clearly to ensure it's transparent to the users.
>
> log.info() should also be used to remind users and provide clear logs.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
