Apply suggestions from code review

Co-authored-by: Richard Bowman <richard.bowman@cantab.net>

Author: julianstirling

pyproject.toml

@@ -57,6 +57,7 @@ addopts = [
     "--cov-report=term",
     "--cov-report=xml:coverage.xml",
     "--cov-report=html:htmlcov",
+    "--cov-report=lcov",
 ]
 
 [tool.ruff]

src/labthings_fastapi/decorators/__init__.py

@@ -100,7 +100,7 @@ def thing_setting(func: Callable) -> ThingSetting:
     This should be used as a decorator with a getter and a setter
     just like a standard python property decorator. If extra functionality
     is not required in the decorator, then using the ThingSetting class
-    directly may allow for clearer code
+    directly may allow for clearer code where the property works like a normal variable.
 
     When creating a Setting using this decorator you must always create a setter
     as it is used to load the value from disk.
@@ -112,7 +112,7 @@ def thing_setting(func: Callable) -> ThingSetting:
     the dictionary representation of this BaseModel as this is what will be used to
     set the Setting when loading from disk on starting the server.
 
-    Note: If a setting updated, rather than explicitly set this will not trigger saving.
+    Note: If a setting is mutated rather than set, this will not trigger saving.
     For example: if a Thing has a setting called `dictsetting` holding the dictionary
     `{"a": 1, "b": 2}` then `self.dictsetting = {"a": 2, "b": 2}` would trigger saving
     but `self.dictsetting[a] = 2` would not, as the setter for `dictsetting` is never

src/labthings_fastapi/descriptors/property.py

@@ -229,7 +229,7 @@ def getter(self, func: Callable) -> Self:
     def setter(self, func: Callable) -> Self:
         """Decorator to set the property's value
 
-        ThingPropertys are variables - so they will return the value they hold
+        ``ThingProperty`` descriptors return the value they hold
         when they are accessed. However, they can run code when they are set: this
         decorator sets a function as that code.
         """
@@ -244,7 +244,7 @@ class ThingSetting(ThingProperty):
     A ThingSetting is a ThingProperty with extra functionality for triggering
     a Thing to save its settings.
 
-    Note: If a setting updated, rather than explicitly set this will not trigger saving.
+    Note: If a setting is mutated rather than assigned to, this will not trigger saving.
     For example: if a Thing has a setting called `dictsetting` holding the dictionary
     `{"a": 1, "b": 2}` then `self.dictsetting = {"a": 2, "b": 2}` would trigger saving
     but `self.dictsetting[a] = 2` would not, as the setter for `dictsetting` is never