Sphinx do not use typing, but a more classical system, with built-in types separted with or
Example, this is incorrect:
|
:type body: Optional[Union[str, bytes]] |
|
|
|
:keyword Optional[dict] application_properties: The user defined properties on the message. |
|
:keyword Optional[str] session_id: The session identifier of the message for a sessionful entity. |
|
:keyword Optional[str] message_id: The id to identify the message. |
|
:keyword Optional[datetime.datetime] scheduled_enqueue_time_utc: The utc scheduled enqueue time to the message. |
|
:keyword Optional[datetime.timedelta] time_to_live: The life duration of a message. |
|
:keyword Optional[str] content_type: The content type descriptor. |
|
:keyword Optional[str] correlation_id: The correlation identifier. |
|
:keyword Optional[str] subject: The application specific subject, sometimes referred to as label. |
|
:keyword Optional[str] partition_key: The partition key for sending a message to a partitioned entity. |
|
:keyword Optional[str] to: The `to` address used for auto_forward chaining scenarios. |
|
:keyword Optional[str] reply_to: The address of an entity to send replies to. |
|
:keyword Optional[str] reply_to_session_id: The session identifier augmenting the `reply_to` address. |
Should be more:
:type body: str or bytes
:keyword dict[str,any] application_properties: The user defined properties on the message.
:keyword dict[str, any] session_id: The session identifier of the message for a sessionful entity.
Can can add or None if the optionality matters, but we should clarify it in the text.
Sphinx do not use
typing, but a more classical system, with built-in types separted withorExample, this is incorrect:
azure-sdk-for-python/sdk/servicebus/azure-servicebus/azure/servicebus/_common/message.py
Lines 69 to 82 in 3fdbaa7
Should be more:
Can can add
or Noneif the optionality matters, but we should clarify it in the text.