search

swar / nba_api

An API Client package to access the APIs for NBA.com
MIT License
2.34k stars 515 forks source link

Update GameIDs Pattern Documentation #437

Closed TylerChasse closed 3 weeks ago

TylerChasse commented 2 months ago

Updated documentation in cumestatsplayer.md and parameters.md to make the formatting of GameIDs more clear.

Resolves #309

rsforbes commented 3 weeks ago

@TylerChasse - Will get this look at this weekend.

rsforbes commented 3 weeks ago

@TylerChasse - I was reviewing this, and when I looked at the pattern I thought, that's not a regular expression pattern. I then went and look at all the other documentation and saw that same. Clearly, we need a major update in the future to fix all of that. A better name would have been "example", and then have an actual regex pattern. Here, the pattern ^(?!.*\|$)\d{10}(?:\|\d{10})*$ would have been perfect.

So, there is no need in this PR to rewrite all documentation. 😀

Accepted. Thanks!!!