diff --git a/docs/conf.py b/docs/conf.py index e7ca5f8f..23f5ece3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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")) ): diff --git a/docs/how-to.md b/docs/how-to.md index a3f95aaf..49d390f5 100644 --- a/docs/how-to.md +++ b/docs/how-to.md @@ -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() `. +Otherwise, you can manually close the session with {meth}`client.close() `. ## Get surveys and questions diff --git a/src/citric/rpc/client.py b/src/citric/rpc/client.py index 93e2475f..45d0e8c6 100644 --- a/src/citric/rpc/client.py +++ b/src/citric/rpc/client.py @@ -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.""" @@ -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 `. @@ -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 """