Skip to content

Commit dbe46e7

Browse files
committed
docs: link dedicated stats guide from README
1 parent 1e6aef5 commit dbe46e7

1 file changed

Lines changed: 4 additions & 12 deletions

File tree

README.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/python-mlb-statsapi)
1010
![GitHub](https://img.shields.io/github/license/zero-sum-seattle/python-mlb-statsapi)
1111

12-
### [Wiki](https://github.com/zero-sum-seattle/python-mlb-statsapi/wiki) | [Methods](docs/methods.md) | [Examples](docs/examples.md) | [Async](docs/async.md) | [Public API](docs/public-api.md) | [MLB Stats API](https://statsapi.mlb.com/)
12+
### [Wiki](https://github.com/zero-sum-seattle/python-mlb-statsapi/wiki) | [Methods](docs/methods.md) | [Examples](docs/examples.md) | [Stats](docs/stats.md) | [Async](docs/async.md) | [Public API](docs/public-api.md) | [MLB Stats API](https://statsapi.mlb.com/)
1313

1414
</div>
1515

@@ -143,7 +143,7 @@ See [Async usage](docs/async.md) for lifecycle, concurrency, custom HTTPX client
143143

144144
Where an async endpoint is supported, both clients return the same Pydantic models and follow the same public HTTP/error behavior.
145145

146-
The async surface is still smaller than the full synchronous API while 1.1 coverage is expanded. The [public API contract](docs/public-api.md#asyncmlb-public-client) is the authoritative list of supported async methods.
146+
The [public API contract](docs/public-api.md#asyncmlb-public-client) is the authoritative list of supported async methods.
147147

148148
## Concurrent Async Requests
149149

@@ -190,16 +190,7 @@ team_ids = mlb.get_team_id("Seattle Mariners")
190190

191191
### Stats
192192

193-
```python
194-
stats = mlb.get_player_stats(
195-
664034,
196-
stats=["season", "career"],
197-
groups=["hitting"],
198-
season=2022,
199-
)
200-
```
201-
202-
Higher-level stats helpers remain on the synchronous `Mlb` client in the current 1.1 async surface.
193+
The stats API has several entry points and returns a nested `stats[group][type]` structure. See the dedicated [Stats Guide](docs/stats.md) for `get_player_stats()`, `get_team_stats()`, `get_stats()`, and `get_players_stats_for_game()` examples using both `Mlb` and `AsyncMlb`.
203194

204195
### Schedule
205196

@@ -258,6 +249,7 @@ print(player.model_dump_json(indent=2))
258249
| [Wiki](https://github.com/zero-sum-seattle/python-mlb-statsapi/wiki) | Endpoint reference, return objects, and model documentation |
259250
| [Method reference](docs/methods.md) | Method signatures and short descriptions from the original README reference |
260251
| [Usage examples](docs/examples.md) | Extended synchronous examples |
252+
| [Stats guide](docs/stats.md) | Player, team, general, and per-game stat queries with sync and async examples |
261253
| [Async usage](docs/async.md) | Async installation, lifecycle, concurrency, and examples |
262254
| [HTTP transport](docs/http-transport.md) | Timeouts, retries, strict HTTP, exceptions, and ownership |
263255
| [Public API contract](docs/public-api.md) | Supported symbols, signatures, endpoint methods, and stability policy |

0 commit comments

Comments
 (0)