Skip to content

Correct note related to "List Check Runs" API #28285

Closed

Description

@mbtools

Code of Conduct

What article on docs.github.com is affected?

First paragraph of "List check runs for a Git reference"

What changes are you suggesting?

"Pushes to a branch in a forked repository are not detected and return an empty pull_requests array." is incorrect.

pull_requests must be replaced with check_runs.

You might also add that total_count will be 0 in such cases.

Additional information

I would have created a PR myself, but "Make a contribution" at the bottom of the page does not lead to the actual content that needs fixing. Where is the file that needs to be changed?

Activity

  1. added
    contentThis issue or pull request belongs to the Docs Content team
    on Sep 15, 2023
  2. welcome commented on Sep 15, 2023

    @welcome

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

  3. added
    triageDo not begin working on this issue until triaged by the team
    on Sep 15, 2023
  4. added and removed
    triageDo not begin working on this issue until triaged by the team
    on Sep 18, 2023
  5. docs-bot commented on Sep 18, 2023

    @docs-bot
    Collaborator

    Thank you for opening this issue! Updates to the REST API, GraphQL API, and webhook reference documentation must be made internally. I have copied your issue to an internal issue, so I will close this issue.

  6. cmwilson21 commented on Sep 18, 2023

    @cmwilson21
    Contributor

    @mbtools Thanks for opening this issue! These types of changes to the REST docs can only be made internally, so I've transferred this issue to the internal repo.

    Thanks again for opening this and for your interest in improving the Docs!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content team

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions