Skip to content

playbook_guide/playbooks_variables.rst: improve style. Assisted-by: AI #2916

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.

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

Merged
merged 4 commits into from
Jul 29, 2025

Conversation

Andersson007
Copy link
Contributor

playbook_guide/playbooks_variables.rst: improve style. Assisted-by: AI

make it satisfy only the following exhaustive list of requirements:
- Produce an RST snippet
- Consider reorganizing RST notes as simple text
- Do not modify the original indentation including code snippets
- You can add more sections, but do not change any existing headings, RST anchors/references
- Generally, use a sentence to introduce a list that is not a procedure
- Fix ambiguous pronouns. Avoid sentences in which a pronoun can refer to more than one noun or in which a pronoun refers to an unstated noun
- When you break a long procedure or tutorial into smaller chunks, include a summary at the start of the procedure or tutorial
- Spell out unknown abbreviations at the first instance
- Use US spelling
- Use present tense
- Use active voice as much as possible
- Use second person (you)
- Avoid first person (I, we, us)
- Place the word "only" immediately before the word or phrase that it modifies
- Use sentence-style capitalization for titles and headings
- Do not use uppercase letters for emphasis
- Do not start a sentence with a lowercase term; rewrite the sentence
- Capitalize the first word of each item in a vertical or definition list
- Use sentence-style capitalization for these table elements: cell contents, column headings, row labels, table captions
- Use "while" only to refer to a period of time. Do not use "while" as a synonym for although or though
- Use "once" to mean one time. Do not use "once" as a conjunction to mean "after" or "when"

@Andersson007 Andersson007 marked this pull request as draft July 28, 2025 08:26
@Andersson007 Andersson007 marked this pull request as ready for review July 28, 2025 09:10
@Andersson007
Copy link
Contributor Author

ready for review

@samccann samccann added backport-2.17 Automatically create a backport for the stable-2.17 branch backport-2.18 Automatically create a backport for the stable-2.18 branch backport-2.19 Automatically create a backport for the stable-2.19 branch labels Jul 29, 2025
@samccann samccann merged commit 7a35c9b into ansible:devel Jul 29, 2025
23 checks passed
Copy link

patchback bot commented Jul 29, 2025

Backport to stable-2.17: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.17/7a35c9b7c54c15f091ad58a94148335274a4de9b/pr-2916

Backported as #2925

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Jul 29, 2025
#2916)

* playbook_guide/playbooks_variables.rst: improve style. Assisted-by: AI

* Return the removed block of text to the end of the file. Assisted-by: AI

* Manual fixes

* Manual fixes

(cherry picked from commit 7a35c9b)
Copy link

patchback bot commented Jul 29, 2025

Backport to stable-2.18: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.18/7a35c9b7c54c15f091ad58a94148335274a4de9b/pr-2916

Backported as #2926

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Jul 29, 2025
#2916)

* playbook_guide/playbooks_variables.rst: improve style. Assisted-by: AI

* Return the removed block of text to the end of the file. Assisted-by: AI

* Manual fixes

* Manual fixes

(cherry picked from commit 7a35c9b)
Copy link

patchback bot commented Jul 29, 2025

Backport to stable-2.19: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.19/7a35c9b7c54c15f091ad58a94148335274a4de9b/pr-2916

Backported as #2927

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Jul 29, 2025
#2916)

* playbook_guide/playbooks_variables.rst: improve style. Assisted-by: AI

* Return the removed block of text to the end of the file. Assisted-by: AI

* Manual fixes

* Manual fixes

(cherry picked from commit 7a35c9b)
Andersson007 added a commit that referenced this pull request Jul 30, 2025
#2916) (#2927)

* playbook_guide/playbooks_variables.rst: improve style. Assisted-by: AI

* Return the removed block of text to the end of the file. Assisted-by: AI

* Manual fixes

* Manual fixes

(cherry picked from commit 7a35c9b)

Co-authored-by: Andrew Klychkov <[email protected]>
Andersson007 added a commit that referenced this pull request Jul 30, 2025
#2916) (#2926)

* playbook_guide/playbooks_variables.rst: improve style. Assisted-by: AI

* Return the removed block of text to the end of the file. Assisted-by: AI

* Manual fixes

* Manual fixes

(cherry picked from commit 7a35c9b)

Co-authored-by: Andrew Klychkov <[email protected]>
Andersson007 added a commit that referenced this pull request Jul 30, 2025
#2916) (#2925)

* playbook_guide/playbooks_variables.rst: improve style. Assisted-by: AI

* Return the removed block of text to the end of the file. Assisted-by: AI

* Manual fixes

* Manual fixes

(cherry picked from commit 7a35c9b)

Co-authored-by: Andrew Klychkov <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-2.17 Automatically create a backport for the stable-2.17 branch backport-2.18 Automatically create a backport for the stable-2.18 branch backport-2.19 Automatically create a backport for the stable-2.19 branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants