Skip to content

Update docstrings to adhere to sphinx standards #14918

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

Jump to bottom
Merged
ephraimbuddy merged 27 commits into from
Mar 22, 2021
Merged

Update docstrings to adhere to sphinx standards #14918

ephraimbuddy merged 27 commits into from
Mar 22, 2021

Conversation

@jlaneve
Copy link
Contributor

@jlaneve jlaneve commented Mar 21, 2021

Certain modules have mechanical mistakes in their docstrings according to sphinx standards. This PR fixes docstrings in 8 modules, namely:

  • YandexCloud
  • GoogleSheetsToGCSOperator
  • GoogleDisplayVideo360GetSDFDownloadOperationSensor
  • SalesforceToGcsOperator
  • GCSToLocalFilesystemOperator
  • FacebookAdsReportToGcsOperator
  • BigQueryToMySqlOperator
  • AzureFileShareToGCSOperator

@boring-cyborg boring-cyborg bot added the provider:google Google (including GCP) related issues label Mar 21, 2021
@boring-cyborg
Copy link

boring-cyborg bot commented Mar 21, 2021

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst)
Here are some useful points:

  • Pay attention to the quality of your code (flake8, pylint and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it’s a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

jlaneve added 15 commits March 21, 2021 03:49
@jlaneve
Fix param type typo in MLEngineStartTrainingJobOperator
47a425d
@jlaneve
Fix param typo in LifeSciencesRunPipelineOperator
b515276
@jlaneve
Remove duplicate param entry in DataprocInstantiateWorkflowTemplateOp…
92ac8e9 
…erator
@jlaneve
Remove duplicate param entry in DataprocInstantiateInlineWorkflowTemp…
ec9a7d3 
…lateOperator
@jlaneve
Update docstring for DataprepRunJobGroupOperator
409f0ef
@jlaneve
Fix typos and add param type for DataflowTemplatedJobStartOperator
6725f58
@jlaneve
Fix param type typo in DataflowStartSqlJobOperator
34ccbbf
@jlaneve
Fix param typo in CloudDataCatalogListTagsOperator
8518941
@jlaneve
Remove unused param from docstring in S3ToFTPOperator
9364ed5
@jlaneve
Fix param name mismatch in GlacierToGCSOperator
6556937
@jlaneve
Fix code block and add param types to DynamoDBToS3Operator
c9e31ad
@jlaneve
Remove unused param in ComputeEngineStopInstanceOperator
5fa5d9b
@jlaneve
Remove unused param in ComputeEngineStartInstanceOperator
8086101
@jlaneve
Remove unused param from ComputeEngineInstanceGroupUpdateManagerTempl…
19feccc 
…ateOperator
@jlaneve
Fix param typo in BigQueryIntervalCheckOperator
3aec010
turbaszek
turbaszek approved these changes Mar 21, 2021
View reviewed changes
Copy link
Member

@turbaszek turbaszek left a comment

Choose a reason for hiding this comment

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

Awesome work!

@jlaneve
Copy link
Contributor Author

jlaneve commented Mar 21, 2021

@turbaszek thank you - I've fixed the CI issues!

@ephraimbuddy ephraimbuddy merged commit e172bd0 into apache:master Mar 22, 2021
@boring-cyborg
Copy link

boring-cyborg bot commented Mar 22, 2021

Awesome work, congrats on your first merged pull request!

@ephraimbuddy
Copy link
Contributor

ephraimbuddy commented Mar 22, 2021

Thanks @jlaneve!!

@kaxil kaxil mentioned this pull request Apr 22, 2021
Merged
kaxil added a commit to astronomer/airflow that referenced this pull request Apr 22, 2021
@kaxil
Bugfix: Fix rendering of object_name in ``GCSToLocalFilesystemOpe…
7338857 
…rator``

apache#14918 made coms consistency changes
where the template_fields was changed for ``GCSToLocalFilesystemOperator``.

While the change was correct since``object`` param was deprecated, the
instance attribute wasn't updated hence you see this error:

```
AttributeError: 'GCSToLocalFilesystemOperator' object has no attribute 'object_name'
```
potiuk pushed a commit that referenced this pull request Apr 22, 2021
@kaxil
Bugfix: Fix rendering of object_name in ``GCSToLocalFilesystemOpe…
3b9a918 
…rator`` (#15487)

#14918 made coms consistency changes
where the template_fields was changed for ``GCSToLocalFilesystemOperator``.

While the change was correct since``object`` param was deprecated, the
instance attribute wasn't updated hence you see this error:

```
AttributeError: 'GCSToLocalFilesystemOperator' object has no attribute 'object_name'
```
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request Sep 17, 2021
@kaxil
Bugfix: Fix rendering of object_name in ``GCSToLocalFilesystemOpe…
bb13bd8 
…rator`` (#15487)

apache/airflow#14918 made coms consistency changes
where the template_fields was changed for ``GCSToLocalFilesystemOperator``.

While the change was correct since``object`` param was deprecated, the
instance attribute wasn't updated hence you see this error:

```
AttributeError: 'GCSToLocalFilesystemOperator' object has no attribute 'object_name'
```
GitOrigin-RevId: 3b9a91806ea102cc2bc00b545f63f57031f458c9
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request Sep 23, 2021
@kaxil
Bugfix: Fix rendering of object_name in ``GCSToLocalFilesystemOpe…
63f4f74 
…rator`` (#15487)

apache/airflow#14918 made coms consistency changes
where the template_fields was changed for ``GCSToLocalFilesystemOperator``.

While the change was correct since``object`` param was deprecated, the
instance attribute wasn't updated hence you see this error:

```
AttributeError: 'GCSToLocalFilesystemOperator' object has no attribute 'object_name'
```
GitOrigin-RevId: 3b9a91806ea102cc2bc00b545f63f57031f458c9
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request Nov 27, 2021
@kaxil
Bugfix: Fix rendering of object_name in ``GCSToLocalFilesystemOpe…
6080ae1 
…rator`` (#15487)

apache/airflow#14918 made coms consistency changes
where the template_fields was changed for ``GCSToLocalFilesystemOperator``.

While the change was correct since``object`` param was deprecated, the
instance attribute wasn't updated hence you see this error:

```
AttributeError: 'GCSToLocalFilesystemOperator' object has no attribute 'object_name'
```
GitOrigin-RevId: 3b9a91806ea102cc2bc00b545f63f57031f458c9
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request Mar 10, 2022
@kaxil
Bugfix: Fix rendering of object_name in ``GCSToLocalFilesystemOpe…
788a2f0 
…rator`` (#15487)

apache/airflow#14918 made coms consistency changes
where the template_fields was changed for ``GCSToLocalFilesystemOperator``.

While the change was correct since``object`` param was deprecated, the
instance attribute wasn't updated hence you see this error:

```
AttributeError: 'GCSToLocalFilesystemOperator' object has no attribute 'object_name'
```
GitOrigin-RevId: 3b9a91806ea102cc2bc00b545f63f57031f458c9
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request Jun 4, 2022
@kaxil
Bugfix: Fix rendering of object_name in ``GCSToLocalFilesystemOpe…
eee7e0a 
…rator`` (#15487)

apache/airflow#14918 made coms consistency changes
where the template_fields was changed for ``GCSToLocalFilesystemOperator``.

While the change was correct since``object`` param was deprecated, the
instance attribute wasn't updated hence you see this error:

```
AttributeError: 'GCSToLocalFilesystemOperator' object has no attribute 'object_name'
```
GitOrigin-RevId: 3b9a91806ea102cc2bc00b545f63f57031f458c9
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request Jul 9, 2022
@kaxil
Bugfix: Fix rendering of object_name in ``GCSToLocalFilesystemOpe…
b670177 
…rator`` (#15487)

apache/airflow#14918 made coms consistency changes
where the template_fields was changed for ``GCSToLocalFilesystemOperator``.

While the change was correct since``object`` param was deprecated, the
instance attribute wasn't updated hence you see this error:

```
AttributeError: 'GCSToLocalFilesystemOperator' object has no attribute 'object_name'
```
GitOrigin-RevId: 3b9a91806ea102cc2bc00b545f63f57031f458c9
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request Aug 27, 2022
@kaxil
Bugfix: Fix rendering of object_name in ``GCSToLocalFilesystemOpe…
04f8e09 
…rator`` (#15487)

apache/airflow#14918 made coms consistency changes
where the template_fields was changed for ``GCSToLocalFilesystemOperator``.

While the change was correct since``object`` param was deprecated, the
instance attribute wasn't updated hence you see this error:

```
AttributeError: 'GCSToLocalFilesystemOperator' object has no attribute 'object_name'
```
GitOrigin-RevId: 3b9a91806ea102cc2bc00b545f63f57031f458c9
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request Oct 4, 2022
@kaxil
Bugfix: Fix rendering of object_name in ``GCSToLocalFilesystemOpe…
44e1864 
…rator`` (#15487)

apache/airflow#14918 made coms consistency changes
where the template_fields was changed for ``GCSToLocalFilesystemOperator``.

While the change was correct since``object`` param was deprecated, the
instance attribute wasn't updated hence you see this error:

```
AttributeError: 'GCSToLocalFilesystemOperator' object has no attribute 'object_name'
```
GitOrigin-RevId: 3b9a91806ea102cc2bc00b545f63f57031f458c9
aglipska pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request Oct 7, 2022
@kaxil
Bugfix: Fix rendering of object_name in ``GCSToLocalFilesystemOpe…
fce9e16 
…rator`` (#15487)

apache/airflow#14918 made coms consistency changes
where the template_fields was changed for ``GCSToLocalFilesystemOperator``.

While the change was correct since``object`` param was deprecated, the
instance attribute wasn't updated hence you see this error:

```
AttributeError: 'GCSToLocalFilesystemOperator' object has no attribute 'object_name'
```
GitOrigin-RevId: 3b9a91806ea102cc2bc00b545f63f57031f458c9
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request Dec 7, 2022
@kaxil
Bugfix: Fix rendering of object_name in ``GCSToLocalFilesystemOpe…
6b27391 
…rator`` (#15487)

apache/airflow#14918 made coms consistency changes
where the template_fields was changed for ``GCSToLocalFilesystemOperator``.

While the change was correct since``object`` param was deprecated, the
instance attribute wasn't updated hence you see this error:

```
AttributeError: 'GCSToLocalFilesystemOperator' object has no attribute 'object_name'
```
GitOrigin-RevId: 3b9a91806ea102cc2bc00b545f63f57031f458c9
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request Jan 27, 2023
@kaxil
Bugfix: Fix rendering of object_name in ``GCSToLocalFilesystemOpe…
9f24c92 
…rator`` (#15487)

apache/airflow#14918 made coms consistency changes
where the template_fields was changed for ``GCSToLocalFilesystemOperator``.

While the change was correct since``object`` param was deprecated, the
instance attribute wasn't updated hence you see this error:

```
AttributeError: 'GCSToLocalFilesystemOperator' object has no attribute 'object_name'
```
GitOrigin-RevId: 3b9a91806ea102cc2bc00b545f63f57031f458c9
kosteev pushed a commit to kosteev/composer-airflow-test-copybara that referenced this pull request Sep 12, 2024
@kaxil
Bugfix: Fix rendering of object_name in ``GCSToLocalFilesystemOpe…
2d6b72d 
…rator`` (#15487)

apache/airflow#14918 made coms consistency changes
where the template_fields was changed for ``GCSToLocalFilesystemOperator``.

While the change was correct since``object`` param was deprecated, the
instance attribute wasn't updated hence you see this error:

```
AttributeError: 'GCSToLocalFilesystemOperator' object has no attribute 'object_name'
```
GitOrigin-RevId: 3b9a91806ea102cc2bc00b545f63f57031f458c9
kosteev pushed a commit to kosteev/composer-airflow-test-copybara that referenced this pull request Sep 13, 2024
@kaxil
Bugfix: Fix rendering of object_name in ``GCSToLocalFilesystemOpe…
31abf3c 
…rator`` (#15487)

apache/airflow#14918 made coms consistency changes
where the template_fields was changed for ``GCSToLocalFilesystemOperator``.

While the change was correct since``object`` param was deprecated, the
instance attribute wasn't updated hence you see this error:

```
AttributeError: 'GCSToLocalFilesystemOperator' object has no attribute 'object_name'
```
GitOrigin-RevId: 3b9a91806ea102cc2bc00b545f63f57031f458c9
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request Sep 17, 2024
@kaxil
Bugfix: Fix rendering of object_name in ``GCSToLocalFilesystemOpe…
a6944d3 
…rator`` (#15487)

apache/airflow#14918 made coms consistency changes
where the template_fields was changed for ``GCSToLocalFilesystemOperator``.

While the change was correct since``object`` param was deprecated, the
instance attribute wasn't updated hence you see this error:

```
AttributeError: 'GCSToLocalFilesystemOperator' object has no attribute 'object_name'
```
GitOrigin-RevId: 3b9a91806ea102cc2bc00b545f63f57031f458c9
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request Nov 7, 2024
@kaxil
Bugfix: Fix rendering of object_name in ``GCSToLocalFilesystemOpe…
8c26f57 
…rator`` (#15487)

apache/airflow#14918 made coms consistency changes
where the template_fields was changed for ``GCSToLocalFilesystemOperator``.

While the change was correct since``object`` param was deprecated, the
instance attribute wasn't updated hence you see this error:

```
AttributeError: 'GCSToLocalFilesystemOperator' object has no attribute 'object_name'
```
GitOrigin-RevId: 3b9a91806ea102cc2bc00b545f63f57031f458c9
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request May 1, 2025
@kaxil
Bugfix: Fix rendering of object_name in ``GCSToLocalFilesystemOpe…
c5d9842 
…rator`` (#15487)

apache/airflow#14918 made coms consistency changes
where the template_fields was changed for ``GCSToLocalFilesystemOperator``.

While the change was correct since``object`` param was deprecated, the
instance attribute wasn't updated hence you see this error:

```
AttributeError: 'GCSToLocalFilesystemOperator' object has no attribute 'object_name'
```
GitOrigin-RevId: 3b9a91806ea102cc2bc00b545f63f57031f458c9
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request May 22, 2025
@kaxil
Bugfix: Fix rendering of object_name in ``GCSToLocalFilesystemOpe…
8d2fbc5 
…rator`` (#15487)

apache/airflow#14918 made coms consistency changes
where the template_fields was changed for ``GCSToLocalFilesystemOperator``.

While the change was correct since``object`` param was deprecated, the
instance attribute wasn't updated hence you see this error:

```
AttributeError: 'GCSToLocalFilesystemOperator' object has no attribute 'object_name'
```
GitOrigin-RevId: 3b9a91806ea102cc2bc00b545f63f57031f458c9
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request Sep 17, 2025
@kaxil
Bugfix: Fix rendering of object_name in ``GCSToLocalFilesystemOpe…
86a2333 
…rator`` (#15487)

apache/airflow#14918 made coms consistency changes
where the template_fields was changed for ``GCSToLocalFilesystemOperator``.

While the change was correct since``object`` param was deprecated, the
instance attribute wasn't updated hence you see this error:

```
AttributeError: 'GCSToLocalFilesystemOperator' object has no attribute 'object_name'
```
GitOrigin-RevId: 3b9a91806ea102cc2bc00b545f63f57031f458c9
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request Oct 15, 2025
@kaxil
Bugfix: Fix rendering of object_name in ``GCSToLocalFilesystemOpe…
94def18 
…rator`` (#15487)

apache/airflow#14918 made coms consistency changes
where the template_fields was changed for ``GCSToLocalFilesystemOperator``.

While the change was correct since``object`` param was deprecated, the
instance attribute wasn't updated hence you see this error:

```
AttributeError: 'GCSToLocalFilesystemOperator' object has no attribute 'object_name'
```
GitOrigin-RevId: 3b9a91806ea102cc2bc00b545f63f57031f458c9
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ephraimbuddy ephraimbuddy ephraimbuddy approved these changes

@turbaszek turbaszek turbaszek approved these changes

@mik-laj mik-laj Awaiting requested review from mik-laj

Assignees

No one assigned

Labels

okay to merge It's ok to merge this PR as it does not require more tests provider:google Google (including GCP) related issues

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jlaneve @turbaszek @ephraimbuddy