Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
edgarrmondragon committed Sep 18, 2024
1 parent 7817601 commit d4e2954
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ def skip_member_filter(
"""
parts = name.split(".")
if (
any(part.startswith("_") for part in parts)
any(part.startswith("_") and part != "_compat" for part in parts)
or name == "citric.rest.client"
or name.startswith(("citric.client", "citric.session", "citric.method"))
):
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ For the full JSON-RPC reference, see the [RemoteControl 2 API docs][rc2api].
:end-before: end example
```

Otherwise, you can manually close the session with {meth}`client.close() <citric.client.RPC.close>`.
Otherwise, you can manually close the session with {meth}`client.close() <citric.rpc.client.RPC.close>`.

## Get surveys and questions

Expand Down
6 changes: 3 additions & 3 deletions src/citric/rpc/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ class FileMetadata:
"""File extension."""

question: QuestionReference
""":class:`~citric.client.QuestionReference` object."""
""":class:`~citric.rpc.client.QuestionReference` object."""

index: int
"""File index."""
Expand All @@ -86,7 +86,7 @@ class UploadedFile:
"""A file uploaded to a survey response."""

meta: FileMetadata
""":class:`~citric.client.FileMetadata` object."""
""":class:`~citric.rpc.client.FileMetadata` object."""

content: io.BytesIO
"""File content as :py:class:`io.BytesIO <io.BytesIO>`.
Expand Down Expand Up @@ -1178,7 +1178,7 @@ def get_uploaded_file_objects(
token: Optional participant token to filter uploaded files.
Yields:
:class:`~citric.client.UploadedFile` objects.
:class:`~citric.rpc.client.UploadedFile` objects.
.. versionadded:: 0.0.13
"""
Expand Down

0 comments on commit d4e2954

Please sign in to comment.