[
https://issues.apache.org/jira/browse/AIRFLOW-5492?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16930105#comment-16930105
]
ASF GitHub Bot commented on AIRFLOW-5492:
-----------------------------------------
pedroortizm commented on pull request #6107: [AIRFLOW-5492] added missing
docstrings
URL: https://github.com/apache/airflow/pull/6107
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-5492\] My Airflow PR"
- https://issues.apache.org/jira/browse/AIRFLOW-5492
- In case you are fixing a typo in the documentation you can prepend your
commit with \[AIRFLOW-5492\], code changes always need a Jira issue.
- In case you are proposing a fundamental code change, you need to create
an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
- In case you are adding a dependency, check if the license complies with
the [ASF 3rd Party License
Policy](https://www.apache.org/legal/resolved.html#category-x).
### Description
- [ ] Here are some details about my PR, including screenshots of any UI
changes:
### 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.
- All the public functions and the classes in the PR contain docstrings
that explain what it does
- If you implement backwards incompatible changes, please leave a note in
the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so
we can assign it to a appropriate release
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> Missing docstring for hive .py
> ------------------------------
>
> Key: AIRFLOW-5492
> URL: https://issues.apache.org/jira/browse/AIRFLOW-5492
> Project: Apache Airflow
> Issue Type: Bug
> Components: utils
> Affects Versions: 1.10.6
> Reporter: Jakob Homan
> Priority: Minor
> Labels: ccoss2019, newbie
>
> Note: This ticket's being created to facilitate a new contributor's workshop
> for Airflow. After the workshop has completed, I'll mark these all available
> for anyone that might like to take them on.
> We need to add doc_strings for both {{schema}} and {{metastore_conn_id}}
> airflow/macros/hive.py:83
> {code:java}
> def closest_ds_partition(
> table, ds, before=True, schema="default",
> metastore_conn_id='metastore_default'):
> """
> This function finds the date in a list closest to the target date.
> An optional parameter can be given to get the closest before or after.
> :param table: A hive table name
> :type table: str
> :param ds: A datestamp ``%Y-%m-%d`` e.g. ``yyyy-mm-dd``
> :type ds: list[datetime.date]
> :param before: closest before (True), after (False) or either side of ds
> :type before: bool or None
> :returns: The closest date
> :rtype: str or None {code}
--
This message was sent by Atlassian Jira
(v8.3.2#803003)
