diff --git a/docs/vale/.vale.ini b/docs/vale/.vale.ini index 7f966cd3246f9dbcd9b208529270729d54784eba..0fbe065755c821863e40c799c936f65383c395f8 100644 --- a/docs/vale/.vale.ini +++ b/docs/vale/.vale.ini @@ -7,7 +7,7 @@ Vocab = geant-jargon, Sphinx Packages = proselint, Microsoft [*] -BasedOnStyles = Vale, Microsoft +BasedOnStyles = Vale, proselint, Microsoft [formats] py = rst diff --git a/lso/app.py b/lso/app.py index 293e5a60f597bb8076c77a583556cd7ee36a42a5..1c28f7639848a7e2a07c041338078f38390643bf 100644 --- a/lso/app.py +++ b/lso/app.py @@ -1,4 +1,4 @@ -"""default app creation.""" +"""Default app creation.""" import lso app = lso.create_app() diff --git a/lso/environment.py b/lso/environment.py index 62b58e5706e5fd73f65d5291f0896d42911073d9..bd547e7521a5cbe40a9e62b2a9d3d0af9330eb46 100644 --- a/lso/environment.py +++ b/lso/environment.py @@ -24,8 +24,7 @@ LOGGING_DEFAULT_CONFIG = { def setup_logging() -> None: """Set up logging using the configured filename. - if LOGGING_CONFIG is defined in the environment, use this for - the filename, otherwise use LOGGING_DEFAULT_CONFIG + If LOGGING_CONFIG is defined in the environment, use this for the filename, otherwise use LOGGING_DEFAULT_CONFIG. """ logging_config = LOGGING_DEFAULT_CONFIG if "LOGGING_CONFIG" in os.environ: diff --git a/lso/routes/default.py b/lso/routes/default.py index 5cace09bff85d51886e2bf901edeed3f9dc9112f..fa3af428f348965f79196d3b657dc3c284e2176c 100644 --- a/lso/routes/default.py +++ b/lso/routes/default.py @@ -1,7 +1,6 @@ """Default route located at the root URL /. -For now only includes a single endpoint that responds with the current version -of the API and LSO. +For now only includes a single endpoint that responds with the current version of the API and LSO. """ import pkg_resources from fastapi import APIRouter diff --git a/lso/routes/device.py b/lso/routes/device.py index 121ffb3c9d55d309fff84b5bc74600c38a3d73fe..2e2b86598f7445449a15f93420b095e9383f458c 100644 --- a/lso/routes/device.py +++ b/lso/routes/device.py @@ -22,14 +22,13 @@ class NodeProvisioningParams(BaseModel): :type dry_run: bool, optional """ - #: Callback URL that is reported back to WFO, this will allow for the - #: workflow to continue once the playbook has been executed. + #: Callback URL that is reported back to WFO, this will allow for the workflow to continue once the playbook has + #: been executed. callback: HttpUrl #: Parameters for the new device. subscription: dict - #: Whether this playbook execution should be a dry run, or run for real. - #: defaults to ``True`` for obvious reasons, also making it an optional - #: parameter. + #: Whether this playbook execution should be a dry run, or run for real. Defaults to ``True`` for obvious reasons, + #: also making it an optional parameter. dry_run: Optional[bool] = True diff --git a/lso/routes/ip_trunk.py b/lso/routes/ip_trunk.py index 7ee6cf69faa1084479302d2f63e2bc983ec03cf2..6d415c7ccef7d849cc4f5ca63ce8d1bb8a98c62d 100644 --- a/lso/routes/ip_trunk.py +++ b/lso/routes/ip_trunk.py @@ -17,17 +17,15 @@ class IPTrunkParams(BaseModel): #: The address where LSO should call back to upon completion. callback: HttpUrl - #: A dictionary representation of the IP trunk - #: subscription that is to be provisioned. + #: A dictionary representation of the IP trunk subscription that is to be provisioned. subscription: dict class IPTrunkProvisioningParams(IPTrunkParams): """Additional parameters for provisioning an IPtrunk.""" - #: Whether this playbook execution should be a dry run, or run for real. - #: defaults to ``True`` for obvious reasons, also making it an optional - #: parameter. + #: Whether this playbook execution should be a dry run, or run for real. Defaults to ``True`` for obvious reasons, + #: also making it an optional parameter. dry_run: Optional[bool] = True #: The type of object that is changed. object: str @@ -36,9 +34,8 @@ class IPTrunkProvisioningParams(IPTrunkParams): class IPTrunkModifyParams(IPTrunkParams): """Additional parameters for modifying an IPtrunk.""" - #: Whether this playbook execution should be a dry run, or run for real. - #: defaults to ``True`` for obvious reasons, also making it an optional - #: parameter. + #: Whether this playbook execution should be a dry run, or run for real. Defaults to ``True`` for obvious reasons, + #: also making it an optional parameter. dry_run: Optional[bool] = True #: The old subscription object, represented as a dictionary. This allows #: for calculating the difference in subscriptions. @@ -55,9 +52,8 @@ class IPTrunkCheckParams(IPTrunkParams): class IPTrunkDeleteParams(IPTrunkParams): """Additional parameters for deleting an IPtrunk.""" - #: Whether this playbook execution should be a dry run, or run for real. - #: defaults to ``True`` for obvious reasons, also making it an optional - #: parameter. + #: Whether this playbook execution should be a dry run, or run for real. Defaults to ``True`` for obvious reasons, + #: also making it an optional parameter. dry_run: Optional[bool] = True