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

pr*: style adjustments #9524

Merged
merged 4 commits into from
Jan 8, 2025

Conversation

russoz
Copy link
Collaborator

@russoz russoz commented Jan 3, 2025

SUMMARY

Second round of doc adjustments. Output width has been slightly reduced in andebox, and a couple of other style improvements have been added (like replacing id with ID)

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

plugins/modules/pacemaker_cluster.py
plugins/modules/packet_device.py
plugins/modules/packet_ip_subnet.py
plugins/modules/packet_volume_attachment.py
plugins/modules/pacman.py
plugins/modules/pagerduty.py
plugins/modules/pagerduty_alert.py
plugins/modules/pagerduty_change.py
plugins/modules/pam_limits.py
plugins/modules/pamd.py
plugins/modules/parted.py
plugins/modules/pear.py
plugins/modules/pids.py
plugins/modules/pip_package_info.py
plugins/modules/pipx.py
plugins/modules/pkgin.py
plugins/modules/pkgng.py
plugins/modules/pkgutil.py
plugins/modules/pmem.py
plugins/modules/portage.py
plugins/modules/pritunl_org.py
plugins/modules/pritunl_user.py
plugins/modules/profitbricks.py
plugins/modules/profitbricks_datacenter.py
plugins/modules/profitbricks_volume.py
plugins/modules/proxmox.py
plugins/modules/proxmox_backup.py
plugins/modules/proxmox_disk.py
plugins/modules/proxmox_kvm.py
plugins/modules/proxmox_nic.py
plugins/modules/proxmox_snap.py
plugins/modules/pubnub_blocks.py
plugins/modules/pulp_repo.py
plugins/modules/puppet.py
plugins/modules/pushbullet.py
plugins/modules/python_requirements_info.py
plugins/modules/redfish_command.py
plugins/modules/redfish_config.py
plugins/modules/redfish_info.py
plugins/modules/redhat_subscription.py
plugins/modules/redis.py
plugins/modules/redis_data_incr.py
plugins/modules/rhsm_release.py
plugins/modules/rhsm_repository.py
plugins/modules/riak.py
plugins/modules/rocketchat.py
plugins/modules/rollbar_deployment.py
plugins/modules/runit.py

@ansibullbot
Copy link
Collaborator

cc @!UNKNOWN @Ajpantuso @ApsOps @ColOfAbRiX @Deepakkothandan @IamLunchbox @JoergFiedler @Kogelvis @L2G @Lowess @MacLemon @TSKushal @Tatsh @Thulium-Drake @UnderGreen @adamvaughan @baldwinSPC @bcoca @Bhavya06 @castorsky @cnsnyder @dch @dermute @drewkerrigan @emonty @fishman @giovannisciortino @helldorado @indrajitr @jake2184 @jasperla @joshainglis @jpdasma @jraby @jsmartin @jsumners @jyundt @karmab @kavu @kevensen @krauthosting @martinm82 @matbu @matburt @mator @maxamillion @mekanix @mizumm @mraineri @nurfet-becirevic @opoplawski @overhacked @paginabianca @parfeon @ptoscano @pubnub @rajeevkallur @renxulei @rosowiecki @saranyasridharan @scathatheworm @seandst @slok @suprememoocow @sysadmind @szinck @t0mk @tchernomax @teebes @thaumos @tomasg2012 @troy2914 @tuxillo @willthames @willybarro @wltjr @xen0l @xmadsen
click here for bot help

@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 Jan 3, 2025
@ansibullbot ansibullbot added needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Jan 3, 2025
@ansibullbot ansibullbot removed needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Jan 4, 2025
created. If there is already an open incident with a matching key, this event will be appended to that incident's
log. The event key provides an easy way to 'de-dup' problem reports. If no O(incident_key) is provided, then it will
be generated by PagerDuty.
- For O(state=acknowledged) or O(state=resolved) - This should be the incident_key you received back when the incident
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Suggested change
- For O(state=acknowledged) or O(state=resolved) - This should be the incident_key you received back when the incident
- For O(state=acknowledged) or O(state=resolved) - This should be the RV(ignore:incident_key) you received back when the incident

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I believe that would make sense, but the RETURN values are not documented. @ApsOps @xshen1 could you please confirm? TIA

plugins/modules/redfish_command.py Outdated Show resolved Hide resolved
@felixfontein
Copy link
Collaborator

The question on pagerduty_alert is still open, but I'll still merge this now so the PR won't get stale (since it modifies a lot of different modules). pagerduty_alert can be corrected if the change is wrong in a follow-up PR.

@felixfontein felixfontein merged commit 568fcea into ansible-collections:main Jan 8, 2025
129 checks passed
Copy link

patchback bot commented Jan 8, 2025

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

❌ Failed to cleanly apply 568fcea on top of patchback/backports/stable-9/568fcea15e48eacffcbc7bd999f28568dafea444/pr-9524

Backporting merged PR #9524 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/568fcea15e48eacffcbc7bd999f28568dafea444/pr-9524 upstream/stable-9
  4. Now, cherry-pick PR pr*: style adjustments #9524 contents into that branch:
    $ git cherry-pick -x 568fcea15e48eacffcbc7bd999f28568dafea444
    If it'll yell at you with something like fatal: Commit 568fcea15e48eacffcbc7bd999f28568dafea444 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 568fcea15e48eacffcbc7bd999f28568dafea444
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR pr*: style adjustments #9524 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-9/568fcea15e48eacffcbc7bd999f28568dafea444/pr-9524
  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.

@felixfontein felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Jan 8, 2025
Copy link

patchback bot commented Jan 8, 2025

Backport to stable-10: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-10/568fcea15e48eacffcbc7bd999f28568dafea444/pr-9524

Backported as #9560

🤖 @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 Jan 8, 2025
* pr*: style adjustments

* revert removal of "null"

* Update plugins/modules/redfish_command.py

* Update plugins/modules/redhat_subscription.py

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

---------

Co-authored-by: Felix Fontein <[email protected]>
(cherry picked from commit 568fcea)
@felixfontein
Copy link
Collaborator

@russoz thanks for contributing this!
@jsumners thanks for reviewing this!

felixfontein pushed a commit that referenced this pull request Jan 8, 2025
pr*: style adjustments (#9524)

* pr*: style adjustments

* revert removal of "null"

* Update plugins/modules/redfish_command.py

* Update plugins/modules/redhat_subscription.py

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

---------

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

Co-authored-by: Alexei Znamensky <[email protected]>
@russoz russoz deleted the pr-doc-style branch January 10, 2025 09:05
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 needs_maintainer plugins plugin (any type) redhat_subscription
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants