Skip to content

Commit 88d0510

Browse files
authored
docs: #110 adds llm friendly documentation and indexable response and request examples. (#123)
code: updates some doc strings to better reflect the response object
1 parent b7f23b5 commit 88d0510

21 files changed

Lines changed: 3310 additions & 144 deletions

‎context7.json‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"$schema": "https://context7.com/schema/context7.json",
3+
"projectTitle": "nhl-api-py",
4+
"description": "Python wrapper for the NHL API — stats, schedules, standings, teams, game data, and EDGE analytics",
5+
"folders": ["docs"],
6+
"excludeFolders": ["tests", ".github"],
7+
"excludeFiles": ["CONTRIBUTING.md"],
8+
"rules": [
9+
"Always import from nhlpy: from nhlpy import NHLClient",
10+
"Game IDs format: YYYYTTNNNN (e.g., 2023020280 = 2023 season, regular season game 280)",
11+
"Season format: YYYYYYYY (e.g., 20242025)",
12+
"Method names have no get_ prefix (e.g., boxscore() not get_boxscore())",
13+
"Team abbreviations are 3 letters (e.g., BUF, TOR, EDM)",
14+
"Many name fields use localized format: {\"default\": \"English\", \"fr\": \"French\"}"
15+
]
16+
}

0 commit comments

Comments
 (0)