Skip to content

Commit

Permalink
Add missing docstring params (apache#15741)
Browse files Browse the repository at this point in the history
  • Loading branch information
jbampton authored May 9, 2021
1 parent 41930fd commit feddc51
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 2 deletions.
2 changes: 1 addition & 1 deletion airflow/providers/airbyte/hooks/airbyte.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ def submit_sync_connection(self, connection_id: str) -> Any:
Submits a job to a Airbyte server.
:param connection_id: Required. The ConnectionId of the Airbyte Connection.
:type connectiond_id: str
:type connection_id: str
"""
return self.run(
endpoint=f"api/{self.api_version}/connections/sync",
Expand Down
1 change: 1 addition & 0 deletions airflow/utils/timezone.py
Original file line number Diff line number Diff line change
Expand Up @@ -169,5 +169,6 @@ def parse(string: str, timezone=None) -> DateTime:
Parse a time string and return an aware datetime
:param string: time string
:param timezone: the timezone
"""
return pendulum.parse(string, tz=timezone or TIMEZONE, strict=False) # type: ignore
1 change: 1 addition & 0 deletions docs/exts/docroles.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ def get_template_field(env, fullname):
"""
Gets template fields for specific operator class.
:param env: env config
:param fullname: Full path to operator class.
For example: ``airflow.providers.google.cloud.operators.vision.CloudVisionCreateProductSetOperator``
:return: List of template field
Expand Down
1 change: 1 addition & 0 deletions docs/exts/docs_build/errors.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ def parse_sphinx_warnings(warning_text: str, docs_dir: str) -> List[DocBuildErro
Parses warnings from Sphinx.
:param warning_text: warning to parse
:param docs_dir: documentation directory
:return: list of DocBuildErrors.
"""
sphinx_build_errors = []
Expand Down
1 change: 1 addition & 0 deletions docs/exts/docs_build/spelling_checks.py
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ def parse_spelling_warnings(warning_text: str, docs_dir: str) -> List[SpellingEr
Parses warnings from Sphinx.
:param warning_text: warning to parse
:param docs_dir: documentation directory
:return: list of SpellingError.
"""
sphinx_spelling_errors = []
Expand Down
3 changes: 2 additions & 1 deletion tests/core/test_core_to_contrib.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@ def skip_test_with_mssql_in_py38(self, path_a="", path_b=""):
@staticmethod
def get_class_from_path(path_to_class, parent=False):
"""
:param parent indicates if "path_to_class" arg is super class
:param path_to_class: the path to the class
:param parent: indicates if "path_to_class" arg is super class
"""

path, _, class_name = path_to_class.rpartition(".")
Expand Down
2 changes: 2 additions & 0 deletions tests/core/test_logging_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,8 @@ def settings_context(content, directory=None, name='LOGGING_CONFIG'):
:param content:
The content of the settings file
:param directory: the directory
:param name: str
"""
initial_logging_config = os.environ.get("AIRFLOW__LOGGING__LOGGING_CONFIG_CLASS", "")
try:
Expand Down

0 comments on commit feddc51

Please sign in to comment.