D205 Support - Provider: Google

[ferruzzi]

Part of #10742

D205 asserts that all docstrings must have a one-line summary ending in a period. If there is more than one sentence then there must be a blank line before the rest of the docstring. Meeting these requirements could be as simple as adding a newline, or might require some rephrasing.

There are almost a thousand violations in the repo so we're going to have to take this in bites.

PLEASE NOTE

There should be zero logic changes in this PR, only changes to docstrings and whitespace. If you see otherwise, please call it out.

Included in this chunk

All files contained in the Google provider package

To test

If you comment out this line and run pre-commit in main you will get around 642 errors. After these changes, "only" 359 remain and no files in any of the above provider packages should be on the list. After uncommenting that line and rerunning pre-commits, there should be zero regressions.

---

^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

[potiuk]

Some build docs failure.

[ferruzzi]

Some build docs failure.

Yeah, I saw those locally but I'm not sure what they mean yet. I'll need to poke at them tonight I guess unless it's obvious to someone else.

[potiuk]

Obviously those are blank indentation issues in docs generated via autoapi that are not-too-obvious where they are coming from as the autoapi+sphinx are known to speak in riddles.

You might have to take a look at generated .rst files in _api folder and hope that you will find out quickly. Other than that, I sometimes had to revert to bisecting to narrow down similar problems and remove parts of my modifications to be able to pin-point the places they were coming from,

Usually it SOME problem with identation that docstrings processesed by Autoapi make Sphinx very unhappy about.

[potiuk]

(and sorry I can't be more helpful :).

[ferruzzi]

Thanks for the tip. Sometimes it's one of those things where someone else will look and say "on, there's an extra space there at the beginning of line 20" or something. I was hoping it was one of those days :P I'll start poking at it this evening and see what I cans see.

[uranusjr]

Use .. seealso:: for this

[uranusjr]

Docstrings in the Google provider is a tower of cards that collapse if you touch it. I don’t have anything good to say about it except good luck… splitting the PR into 10 could be a good idea to isolate the issue (although it may not help you understand why there’s an issue).

[ferruzzi]

splitting the PR into 10

I may do just that. I was trying to keep it in reasonable chunks rather than flooding a hundred PRs but I think you are right on this one. I'll try to get to it tonight, I didn't have time last night to look into it.

[ferruzzi]

Alright, everything is passing locally now, let's see if I did the right magic incantation this time.