From 2e13b72f090e7163b03247bbb96ac982e2db6402 Mon Sep 17 00:00:00 2001 From: Jonas Obrist Date: Thu, 15 Aug 2024 18:57:15 +0900 Subject: [PATCH] manually document enums --- docs/usage.rst | 43 ++++++++++++++++++++++++++++++++++--------- 1 file changed, 34 insertions(+), 9 deletions(-) diff --git a/docs/usage.rst b/docs/usage.rst index b538ba2..97358ea 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -387,24 +387,49 @@ Models :members: enabled, view_type :undoc-members: -.. autoclass:: aiodynamo.models..StreamViewType - :members: keys_only, new_image, old_image, new_and_old_images - :undoc-members: +.. py:class:: aiodynamo.models.StreamViewType + + .. py:attribute:: keys_only + .. py:attribute:: new_image + .. py:attribute:: old_image + .. py:attribute:: new_and_old_images .. autoclass:: aiodynamo.models.RetryConfig :members: time_limit_secs, default, default_wait_config, delays -.. autoclass:: aiodynamo.models.ReturnValues - :members: none, all_old, updated_old, all_new, updated_new - :undoc-members: +.. py:class:: aiodynamo.models.ReturnValues + + Not all of these options are valid for all APIs that expect a :py:class:`ReturnValues`, please refer to the DynamoDB documentation for acceptable values. + + .. py:attribute:: none + + Return nothing + + .. py:attribute:: all_old + + Return the item as it was before the request + + .. py:attribute:: updated_old + + Return the part of the item before the request that was updated. + + .. py:attribute:: all_new + + Return the item as it was after the request. + + .. py:attribute:: updated_new + + Return the part of the item that was updated. .. autoclass:: aiodynamo.models.Projection :members: type, attrs :undoc-members: -.. autoclass:: aiodynamo.models.ProjectionType - :members: all, keys_only, include - :undoc-members: +.. py:class:: aiodynamo.models.ProjectionType + + .. py:attribute:: all + .. py:attribute:: keys_only + .. py:attribute:: include .. autoclass:: aiodynamo.models.BatchGetRequest :members: keys, projection