Skip to content

Comments

Align GCS operator documentation headings with RST style#61578

Merged
shahar1 merged 3 commits intoapache:mainfrom
KamranImaaz:fix-docs-operators
Feb 7, 2026
Merged

Align GCS operator documentation headings with RST style#61578
shahar1 merged 3 commits intoapache:mainfrom
KamranImaaz:fix-docs-operators

Conversation

@KamranImaaz
Copy link
Contributor


Was generative AI tooling used to co-author this PR?
  • Yes (please specify the tool below)

  • Read the Pull Request Guidelines for more information. Note: commit author/co-author name and email in commits become permanently public when merged.
  • For fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
  • When adding dependency, check compliance with the ASF 3rd Party License Policy.
  • For significant user-facing changes create newsfragment: {pr_number}.significant.rst or {issue_number}.significant.rst, in airflow-core/newsfragments.

@KamranImaaz KamranImaaz requested a review from shahar1 as a code owner February 7, 2026 08:09
@boring-cyborg boring-cyborg bot added area:providers kind:documentation provider:google Google (including GCP) related issues labels Feb 7, 2026
@KamranImaaz
Copy link
Contributor Author

@shahar1 Now all the Doc files in Operator's docs follow one heading font size for operators. Please have a look.

@shahar1
Copy link
Contributor

shahar1 commented Feb 7, 2026

Hey @KamranImaaz, specifically for updating the headings I'd prefer that you'll create a single PR to fix all sections of all related files at once, rather than multiple PRs. Please consider if you plan to create more PRs (no need to fix existing ones).

@KamranImaaz
Copy link
Contributor Author

Hey Shahar I asked this question in the #61365 I thought raising seperate would be good. But since now all the Headings are covered there is nothing left to do. Sorry for the inconvinence caused. From Next time onwards when I encounter such situaution I will raise all of them in a single PR.

@shahar1
Copy link
Contributor

shahar1 commented Feb 7, 2026

Hey Shahar I asked this question in the #61365 I thought raising seperate would be good. But since now all the Headings are covered there is nothing left to do. Sorry for the inconvinence caused. From Next time onwards when I encounter such situaution I will raise all of them in a single PR.

No problem at all! I'll try to clarify -
If you make changes to multiple code parts of unrelated files, than it's better to do so in separate PRs, so if we encounter an issue in any of them - it would be easier to isolate the source of the issue.
If it's only updating style of sections in docs like in this case, and the changes have the same nature - I'd prefer that it will be in a single PR because it shouldn't affect any logic inside the code.
I hope that it makes sense - it's probably a matter of time and experience until you feel what is more suitable for each case.

@KamranImaaz
Copy link
Contributor Author

Hey Shahar I asked this question in the #61365 I thought raising seperate would be good. But since now all the Headings are covered there is nothing left to do. Sorry for the inconvinence caused. From Next time onwards when I encounter such situaution I will raise all of them in a single PR.

No problem at all! I'll try to clarify - If you make changes to multiple code parts of unrelated files, than it's better to do so in separate PRs, so if we encounter an issue in any of them - it would be easier to isolate the source of the issue. If it's only updating style of sections in docs like in this case, and the changes have the same nature - I'd prefer that it will be in a single PR because it shouldn't affect any logic inside the code. I hope that it makes sense - it's probably a matter of time and experience until you feel what is more suitable for each case.

Yes Sure I will keep in mind this one. Thanks for always helping and suggesting me :)

@shahar1 shahar1 changed the title Fix Operators and Sensors in GCS RST file Align GCS operator documentation headings with RST style Feb 7, 2026
@shahar1
Copy link
Contributor

shahar1 commented Feb 7, 2026

Hey Shahar I asked this question in the #61365 I thought raising seperate would be good. But since now all the Headings are covered there is nothing left to do. Sorry for the inconvinence caused. From Next time onwards when I encounter such situaution I will raise all of them in a single PR.

No problem at all! I'll try to clarify - If you make changes to multiple code parts of unrelated files, than it's better to do so in separate PRs, so if we encounter an issue in any of them - it would be easier to isolate the source of the issue. If it's only updating style of sections in docs like in this case, and the changes have the same nature - I'd prefer that it will be in a single PR because it shouldn't affect any logic inside the code. I hope that it makes sense - it's probably a matter of time and experience until you feel what is more suitable for each case.

Yes Sure I will keep in mind this one. Thanks for always helping and suggesting me :)

CI issues should have been fixed so you could merge from main - please note that there are issue probably related to the changes in this PR:
https://github.com/apache/airflow/actions/runs/21776944806/job/62835224588?pr=61578
https://github.com/apache/airflow/actions/runs/21776944806/job/62835224593?pr=61578

@KamranImaaz
Copy link
Contributor Author

Okay Sure Shahar. I'll update you by tonight!!

@shahar1 shahar1 merged commit 870b5ab into apache:main Feb 7, 2026
72 checks passed
@KamranImaaz KamranImaaz deleted the fix-docs-operators branch February 8, 2026 08:54
jhgoebbert pushed a commit to jhgoebbert/airflow_Owen-CH-Leung that referenced this pull request Feb 8, 2026
Ratasa143 pushed a commit to Ratasa143/airflow that referenced this pull request Feb 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:providers kind:documentation provider:google Google (including GCP) related issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants