reduce repetitive phrasing in About the REST API - #45469
Conversation
|
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. |
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
subatoi
left a comment
There was a problem hiding this comment.
Hi @Anujakhatri I agree with your general assessment and the changes you've proposed to the first 3 paragraphs, but not the 4th. If you're happy to revert that last change, I can get this merged for you. Thanks!
| For a list of libraries to facilitate scripting with the REST API, see [AUTOTITLE](/rest/using-the-rest-api/libraries-for-the-rest-api). | ||
|
|
||
| If you are building scripts or applications that use the REST API, you might also be interested in using webhooks to get notified about events or a {% data variables.product.prodname_github_app %} to access resources on behalf of a user or in an organization. For more information, see [AUTOTITLE](/webhooks/about-webhooks) and [AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/deciding-when-to-build-a-github-app). | ||
| You might also use webhooks to get notified about events, or build a {% data variables.product.prodname_github_app %} to act on behalf of a user or organization. For more information, see [AUTOTITLE](/webhooks/about-webhooks) and [AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/deciding-when-to-build-a-github-app). |
There was a problem hiding this comment.
This is a matter of choice; I'd prefer to leave the original text here as some of the intended meaning is lost in the change
Why:
Closes:
What's being changed (if available, include any code snippets, screenshots, or gifs):
Reworded the three bullet intros under "Getting started with the
REST API" in
content/rest/about-the-rest-api/about-the-rest-api.md.The phrase "you may find it helpful to refer to" was repeated across
all three, making the section feel repetitive. Each intro now uses
different, more direct phrasing. Also tightened the closing paragraph
about webhooks and GitHub Apps for conciseness. No changes to links,
front matter, or the "Further reading" section.
Before:
After:
Check off the following: