Add warnings about GitHub API limitations for PRs #2837
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…tch size calculations in documentation
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
There are discrepancies between the schemas of pull requests retrieved from ingestion versus live-events. As a result, some properties can only be calculated when using live-events and are not available during ingestion.
Since this limitation originates from the GitHub API itself, we should add a clear warning in the documentation to make users aware of this constraint.
Added docs pages
Updated docs pages
Working Agreements and Measuring PR standards (
docs/guides/all/working_agreements_and_measuring_pr_standards.md)