Skip to content

Commit 2dd0948

Browse files
committed
Fix some outdated info in docs
1 parent 880f7c7 commit 2dd0948

3 files changed

Lines changed: 5 additions & 5 deletions

File tree

docs/user_guide/advanced.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,7 @@ By default most API requests are cached according to `Cache-Control` headers sen
3030
similar to browser behavior. This significantly reduces rate-limit and bandwidth usage for repeat requests.
3131

3232
Typically responses are cached for a few minutes, but some
33-
infrequently-changing data (like taxa and places) are cached for longer periods, and some more
34-
frequently-changing data (like observations) are not cached at all.
33+
infrequently-changing data (like taxa and places) are cached for longer periods.
3534

3635
You can change any of this behavior using {py:class}`.ClientSession`.
3736
For example, to cache all requests for 1 day:
@@ -94,7 +93,7 @@ Similarly, if you are seeing intermittent non-timeout errors due to server issue
9493
the number of times to retry failed requests (default: 5):
9594
```python
9695
>>> from pyinaturalist import ClientSession
97-
>>> session = ClientSession(retries=7)
96+
>>> session = ClientSession(max_retries=7)
9897
```
9998

10099
## Rate Limiting

docs/user_guide/client.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ In addition to the lower-level API wrapper functions, pyinaturalist provides {py
1010
All API calls are available as methods on {py:class}`.iNatClient`, grouped by resource type. For example:
1111
* Annotation requests: {py:class}`iNatClient.annotations <.AnnotationController>`
1212
* Identification requests: {py:class}`iNatClient.identifications <.IdentificationController>`
13+
* Observation field requests: {py:class}`iNatClient.observation_fields <.ObservationFieldController>`
1314
* Observation requests: {py:class}`iNatClient.observations <.ObservationController>`
1415
* Place requests: {py:class}`iNatClient.places <.PlaceController>`
1516
* Project requests: {py:class}`iNatClient.projects <.ProjectController>`
@@ -108,7 +109,7 @@ See :py:class:`.ClientSession` and :ref:`advanced` for details on these settings
108109

109110
`iNatClient` will accept any arguments for `ClientSession`, for example:
110111
```py
111-
>>> client = iNatClient(per_minute=50, expire_after=3600, timeout=30, retries=3)
112+
>>> client = iNatClient(per_minute=50, expire_after=3600, timeout=30, max_retries=3)
112113
```
113114

114115
Or you can provide your own session object:

docs/user_guide/general.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ And they can be converted back to a JSON dict if needed:
179179
json_observations = [obs.to_dict() for obs in observations]
180180
```
181181

182-
In a future release, these models will be fully integrated with API query functions. To preview these features, see {ref}`api-client`.
182+
These models are fully integrated with the {py:class}`.iNatClient` interface, which returns typed model objects and is the recommended way to use pyinaturalist. See {ref}`api-client` for more details.
183183

184184
## API Recommended Practices
185185
See [API Recommended Practices](https://www.inaturalist.org/pages/api+recommended+practices)

0 commit comments

Comments
 (0)