Skip to content

Commit 824605a

Browse files
authored
[EG] sphinx changes (#33745)
* sphinx changes * remove from pyproject still tags mgmt pckgs * Update sdk/eventgrid/azure-eventgrid/pyproject.toml
1 parent ab636b1 commit 824605a

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

sdk/eventgrid/azure-eventgrid/azure/eventgrid/_helpers.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ def generate_sas(
3333
) -> str:
3434
"""Helper method to generate shared access signature given hostname, key, and expiration date.
3535
:param str endpoint: The topic endpoint to send the events to.
36-
Similar to <YOUR-TOPIC-NAME>.<YOUR-REGION-NAME>-1.eventgrid.azure.net
36+
Similar to <YOUR-TOPIC-NAME>.<YOUR-REGION-NAME>-1.eventgrid.azure.net
3737
:param str shared_access_key: The shared access key to be used for generating the token
3838
:param datetime.datetime expiration_date_utc: The expiration datetime in UTC for the signature.
3939
:keyword str api_version: The API Version to include in the signature.
40-
If not provided, the default API version will be used.
40+
If not provided, the default API version will be used.
4141
:return: A shared access signature string.
4242
:rtype: str
4343
@@ -50,6 +50,7 @@ def generate_sas(
5050
:language: python
5151
:dedent: 0
5252
:caption: Generate a shared access signature.
53+
5354
"""
5455
full_endpoint = "{}?apiVersion={}".format(
5556
endpoint, api_version

sdk/eventgrid/azure-eventgrid/azure/eventgrid/_models.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,11 +103,12 @@ def from_json(cls, event):
103103
"""
104104
Returns the deserialized EventGridEvent object when a json payload is provided.
105105
:param event: The json string that should be converted into a EventGridEvent. This can also be
106-
a storage QueueMessage, eventhub's EventData or ServiceBusMessage
106+
a storage QueueMessage, eventhub's EventData or ServiceBusMessage
107107
:type event: object
108108
:rtype: EventGridEvent
109109
:return: An EventGridEvent object.
110110
:raises ValueError: If the provided JSON is invalid.
111+
111112
"""
112113
dict_event = _get_json_content(event)
113114
return cast(EventGridEvent, EventGridEvent.from_dict(dict_event))

sdk/eventgrid/azure-eventgrid/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22
pyright = false
33
type_check_samples = false
44
verifytypes = false
5+
strict_sphinx = true

0 commit comments

Comments
 (0)