Skip to content

Commit c5da2d9

Browse files
strict sphinx modelsrepository (#36123)
* strict sphinx modelsrepository * update init docstring
1 parent d9a17f9 commit c5da2d9

File tree

2 files changed

+18
-14
lines changed

2 files changed

+18
-14
lines changed

sdk/modelsrepository/azure-iot-modelsrepository/azure/iot/modelsrepository/_client.py

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -45,25 +45,27 @@ class ModelsRepositoryClient(object):
4545

4646
def __init__(self, **kwargs): # pylint: disable=missing-client-constructor-parameter-credential
4747
# type: (Any) -> None
48-
"""
48+
"""Create a client for working with the Azure IoT Models Repository.
49+
50+
For additional request configuration options, please see [core options](https://aka.ms/azsdk/python/options).
51+
4952
:keyword str repository_location: Location of the Models Repository you wish to access.
5053
This location can be a remote HTTP/HTTPS URL, or a local filesystem path.
5154
If omitted, will default to using "https://devicemodels.azure.com".
5255
:keyword str dependency_resolution: Dependency resolution mode.
5356
Possible values:
54-
- "disabled": Do not resolve model dependencies
55-
- "enabled": Resolve model dependencies from the repository
56-
- "tryFromExpanded": Attempt to resolve model and dependencies from an expanded
57-
model DTDL document in the repository. If this is not successful, will fall
58-
back on manually resolving dependencies in the repository
57+
58+
- "disabled": Do not resolve model dependencies
59+
- "enabled": Resolve model dependencies from the repository
60+
- "tryFromExpanded": Attempt to resolve model and dependencies from an expanded
61+
model DTDL document in the repository. If this is not successful, will fall
62+
back on manually resolving dependencies in the repository.
63+
5964
If using the default repository location, the default dependency resolution mode will
6065
be "tryFromExpanded". If using a custom repository location, the default dependency
6166
resolution mode will be "enabled".
6267
:keyword str api_version: The API version for the Models Repository Service you wish to
6368
access.
64-
65-
For additional request configuration options, please see [core options](https://aka.ms/azsdk/python/options).
66-
6769
:raises: ValueError if an invalid argument is provided
6870
"""
6971
repository_location = kwargs.get("repository_location", _DEFAULT_LOCATION)
@@ -114,11 +116,12 @@ def get_models(self, dtmis, **kwargs):
114116
:keyword str dependency_resolution: Dependency resolution mode override. This value takes
115117
precedence over the value set on the client.
116118
Possible values:
117-
- "disabled": Do not resolve model dependencies
118-
- "enabled": Resolve model dependencies from the repository
119-
- "tryFromExpanded": Attempt to resolve model and dependencies from an expanded
120-
model DTDL document in the repository. If this is not successful, will fall
121-
back on manually resolving dependencies in the repository
119+
120+
- "disabled": Do not resolve model dependencies
121+
- "enabled": Resolve model dependencies from the repository
122+
- "tryFromExpanded": Attempt to resolve model and dependencies from an expanded
123+
model DTDL document in the repository. If this is not successful, will fall
124+
back on manually resolving dependencies in the repository
122125
123126
:raises: ValueError if given an invalid dependency resolution mode
124127
:raises: ~azure.iot.modelsrepository.ModelError if there is an error parsing the retrieved model(s)

sdk/modelsrepository/azure-iot-modelsrepository/pyproject.toml

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

0 commit comments

Comments
 (0)