reflect new line-length in docstrings, add proselint as docs linter

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

lso/app.py

-"""default app creation."""
+"""Default app creation."""
 import lso
 
 app = lso.create_app()

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:

lso/routes/default.py

 """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

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
 
 

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