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

Proposal: Add Documentation for game_id Parameter in parameters.md #455

Open
gmortensen opened this issue Jul 31, 2024 · 1 comment
Open
Labels
enhancement New feature or request

Comments

@gmortensen
Copy link

The parameters.md file includes a section for the game_id parameter but currently lacks detailed information. To improve clarity and usability, the following details could be added:

Expected Format:
The game_id should be a 10-digit number. The expected format can be validated using the regex ^\d{10}$.

Meaning of the Third Digit:
The third digit in the game_id indicates the type of season. Here are the details:

1: Preseason game
2: Regular season game
3: All-Star weekend game
4: Playoff game
5: Play-in game

Examples:

0022200147: Regular season game (third digit is 2)
0012200147: Preseason game (third digit is 1)

Proposal:
Update the game_id section in the parameters.md file to include the expected format and an explanation of the third digit's significance.

@gmortensen gmortensen changed the title [Proposal Add Documentation for game_id Parameter in parameters.md Proposal: Add Documentation for game_id Parameter in parameters.md Jul 31, 2024
@gmortensen
Copy link
Author

NBA API Version
V1.5.0

@rsforbes rsforbes added the enhancement New feature or request label Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants