Skip to content
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

[ab]*.py: normalize docs #9421

Merged
merged 2 commits into from
Dec 27, 2024
Merged

Conversation

russoz
Copy link
Collaborator

@russoz russoz commented Dec 27, 2024

SUMMARY

Normalize doc blocks.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

plugins/modules/aerospike_migrations.py
plugins/modules/airbrake_deployment.py
plugins/modules/aix_devices.py
plugins/modules/aix_filesystem.py
plugins/modules/aix_inittab.py
plugins/modules/aix_lvg.py
plugins/modules/aix_lvol.py
plugins/modules/alerta_customer.py
plugins/modules/ali_instance.py
plugins/modules/ali_instance_info.py
plugins/modules/alternatives.py
plugins/modules/android_sdk.py
plugins/modules/ansible_galaxy_install.py
plugins/modules/apache2_mod_proxy.py
plugins/modules/apache2_module.py
plugins/modules/apk.py
plugins/modules/apt_repo.py
plugins/modules/apt_rpm.py
plugins/modules/archive.py
plugins/modules/atomic_container.py
plugins/modules/atomic_host.py
plugins/modules/atomic_image.py
plugins/modules/awall.py
plugins/modules/beadm.py
plugins/modules/bearychat.py
plugins/modules/bigpanda.py
plugins/modules/bitbucket_access_key.py
plugins/modules/bitbucket_pipeline_key_pair.py
plugins/modules/bitbucket_pipeline_known_host.py
plugins/modules/bitbucket_pipeline_variable.py
plugins/modules/bootc_manage.py
plugins/modules/bower.py
plugins/modules/btrfs_info.py
plugins/modules/btrfs_subvolume.py
plugins/modules/bundler.py
plugins/modules/bzr.py

@ansibullbot ansibullbot added docs module module plugins plugin (any type) labels Dec 27, 2024
@felixfontein felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-9 Automatically create a backport for the stable-9 branch backport-10 Automatically create a backport for the stable-10 branch labels Dec 27, 2024
@felixfontein felixfontein merged commit 2a2a966 into ansible-collections:main Dec 27, 2024
129 checks passed
Copy link

patchback bot commented Dec 27, 2024

Backport to stable-9: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 2a2a966 on top of patchback/backports/stable-9/2a2a9661d919d26f125bf8fcb4fdfef36162825c/pr-9421

Backporting merged PR #9421 into main

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/ansible-collections/community.general.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/stable-9/2a2a9661d919d26f125bf8fcb4fdfef36162825c/pr-9421 upstream/stable-9
  4. Now, cherry-pick PR [ab]*.py: normalize docs #9421 contents into that branch:
    $ git cherry-pick -x 2a2a9661d919d26f125bf8fcb4fdfef36162825c
    If it'll yell at you with something like fatal: Commit 2a2a9661d919d26f125bf8fcb4fdfef36162825c is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 2a2a9661d919d26f125bf8fcb4fdfef36162825c
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR [ab]*.py: normalize docs #9421 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-9/2a2a9661d919d26f125bf8fcb4fdfef36162825c/pr-9421
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

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

Copy link

patchback bot commented Dec 27, 2024

Backport to stable-10: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-10/2a2a9661d919d26f125bf8fcb4fdfef36162825c/pr-9421

Backported as #9427

🤖 @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 Dec 27, 2024
* [ab]*.py: normalize docs

* Update plugins/modules/atomic_image.py

Co-authored-by: Felix Fontein <[email protected]>

---------

Co-authored-by: Felix Fontein <[email protected]>
(cherry picked from commit 2a2a966)
@felixfontein felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Dec 27, 2024
@felixfontein
Copy link
Collaborator

@russoz thanks!

felixfontein pushed a commit that referenced this pull request Dec 27, 2024
[ab]*.py: normalize docs (#9421)

* [ab]*.py: normalize docs

* Update plugins/modules/atomic_image.py

Co-authored-by: Felix Fontein <[email protected]>

---------

Co-authored-by: Felix Fontein <[email protected]>
(cherry picked from commit 2a2a966)

Co-authored-by: Alexei Znamensky <[email protected]>
@russoz russoz deleted the ab-docs branch December 27, 2024 21:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-9 Automatically create a backport for the stable-9 branch backport-10 Automatically create a backport for the stable-10 branch docs module module plugins plugin (any type)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants