Skip to content

Commit 711fa99

Browse files
committed
Update documentation
1 parent d18a19f commit 711fa99

3 files changed

Lines changed: 5 additions & 6 deletions

File tree

docs/index.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,7 @@ <h2 id="features">Features <a href="#features" class="anchor">#</a></h2>
8989
<ul>
9090
<li>Strong typing via Pydantic models</li>
9191
<li>Automatic retries with configurable max attempts</li>
92-
<li>Token-bucket rate limiting (default 60 req/min)</li>
93-
<li>In-memory caching for ratings pages</li>
92+
<li>Token-bucket rate limiting (fixed at 60 req/min)</li>
9493
<li>Cursor-based pagination for all list/search endpoints</li>
9594
<li>Clear error hierarchy for precise exception handling</li>
9695
<li>
@@ -134,7 +133,7 @@ <h2 id="documentation">
134133
</li>
135134
<li>
136135
<a href="configuration.html">Configuration</a> &mdash; Tuning retries,
137-
rate limits, timeouts, and headers
136+
timeouts, and headers
138137
</li>
139138
<li>
140139
<a href="reference.html">API Reference</a> &mdash; Full method and

docs/reference.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h2 id="low-level">Low-level <a href="#low-level" class="anchor">#</a></h2>
6666
<table>
6767
<tr><th>Method</th><th>Returns</th><th>Description</th></tr>
6868
<tr><td><code>raw_query(payload)</code></td><td><code>dict</code></td><td>Send a raw GraphQL payload</td></tr>
69-
<tr><td><code>close()</code></td><td><code>None</code></td><td>Close the HTTP client and clear caches</td></tr>
69+
<tr><td><code>close()</code></td><td><code>None</code></td><td>Close the HTTP client</td></tr>
7070
</table>
7171

7272
<hr />

docs/usage.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ <h2 id="get-professor">Get a Professor by ID <a href="#get-professor" class="anc
8585
print(f"Difficulty: {prof.level_of_difficulty}")
8686
print(f"Would take again: {prof.percent_take_again}%")</code></pre>
8787

88-
<h2 id="professor-ratings">Professor Ratings (Paginated, Cached) <a href="#professor-ratings" class="anchor">#</a></h2>
88+
<h2 id="professor-ratings">Professor Ratings (Paginated) <a href="#professor-ratings" class="anchor">#</a></h2>
8989
<pre><code class="language-python">with RMPClient() as client:
9090
page = client.get_professor_ratings_page("2823076", page_size=10)
9191
print(f"Professor: {page.professor.name}")
@@ -103,7 +103,7 @@ <h2 id="iterate-professor-ratings">Iterate All Professor Ratings <a href="#itera
103103
for rating in client.iter_professor_ratings("2823076", since=date(2024, 1, 1)):
104104
print(rating.date, rating.quality, rating.comment)</code></pre>
105105

106-
<h2 id="school-ratings">School Ratings (Paginated, Cached) <a href="#school-ratings" class="anchor">#</a></h2>
106+
<h2 id="school-ratings">School Ratings (Paginated) <a href="#school-ratings" class="anchor">#</a></h2>
107107
<pre><code class="language-python">with RMPClient() as client:
108108
page = client.get_school_ratings_page("1466", page_size=10)
109109
for rating in page.ratings:

0 commit comments

Comments
 (0)