docs(pull_request_webhook_properties): update ‘action’ description

[jai]

Signed-off-by: Jai Govindani [email protected]

Why:

Closes #2257

What's being changed:

Turned the description of the pull_request payload object action into a list to prepare for adding a description to various terms like synchronize (as mentioned in #2257)

Check off the following:

• I have reviewed my changes in staging. (look for the deploy-to-heroku link in your pull request, then click View deployment)
• For content changes, I have reviewed the localization checklist
• For content changes, I have reviewed the Content style guide for GitHub Docs.

Writer impact (This section is for GitHub staff members only):

• This pull request impacts the contribution experience
  • I have added the 'writer impact' label
  • I have added a description and/or a video demo of the changes below (eg. a "before and after video")

[welcome]

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[jai]

Not sure if the list delimiters (between the item and the description) should be hyphens or colons, seeing both on

https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#pull_request_review

https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#release

[jai]

Link to specific section in preview deployment: https://docs-5945--jaifix-2257.herokuapp.com/en/developers/webhooks-and-events/webhook-events-and-payloads#pull_request

[janiceilene]

@jai Thank you so much for opening a PR to make this fix and giving such detailed information about your changes! I'll get this triaged for review ⚡

[skedwards88]

🎉 Thank you for opening this PR! I like your idea to turn the info into a bulleted list to make it more readable.

Our repo is currently frozen for a release tomorrow, but I will queue this to merge as soon as the freeze lifts.

[skedwards88]

Not sure if the list delimiters (between the item and the description) should be hyphens or colons, seeing both

Good catch! Given this discrepancy, either choice is good. As a long term fix, we should choose one and update the style guide/existing articles. (You are quite welcome to open an issue for this, but definitely not expected to!)

[jai]

I'll open an issue and propose an addition to the Style Guide, coming soon!

[jai]

@skedwards88 I proposed something here #6010. Hope the wording wasn't too meta/obscure, happy to make it more human-friendly. Writing docs on how to write docs is a bit meta after all 😂

[jai]

I'll open an issue and propose an addition to the Style Guide, coming soon!

opened #6009

[github-actions]

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡