perf: add more docstrings

.github/workflows/bumpversion.yml

@@ -23,6 +23,6 @@ jobs:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           branch: main
       - name: Create release Version
-        run: gh release create ${{ steps.cz.outputs.version }} --generate-notes
+        run: gh release create v${{ steps.cz.outputs.version }} --generate-notes
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

photoshop/api/_documents.py

@@ -9,6 +9,8 @@
 
 # pylint: disable=too-many-public-methods, too-many-arguments
 class Documents(Photoshop):
+    """The collection of open documents."""
+
     def __init__(self, parent):
         super().__init__(parent=parent)
 

photoshop/api/_layerComp.py

@@ -3,6 +3,8 @@
 
 
 class LayerComp(Photoshop):
+    """A snapshot of a state of the layers in a document (can be used to view different page layouts or compostions)."""
+
     def __init__(self, parent):
         super().__init__(parent=parent)
 

photoshop/api/_layerComps.py

@@ -5,6 +5,8 @@
 
 
 class LayerComps(Photoshop):
+    """The layer comps collection in this document."""
+
     def __init__(self, parent):
         super().__init__(parent=parent)
 

photoshop/api/_layers.py

@@ -6,6 +6,8 @@
 
 # pylint: disable=too-many-public-methods
 class Layers(Photoshop):
+    """The layers collection in the document."""
+
     def __init__(self, parent):
         super().__init__(parent=parent)
 

photoshop/api/_measurement_log.py

@@ -3,6 +3,8 @@
 
 
 class MeasurementLog(Photoshop):
+    """The log of measurements taken."""
+
     def __init__(self, parent):
         super().__init__(parent=parent)
 

photoshop/api/_text_fonts.py

@@ -5,6 +5,8 @@
 
 
 class TextFonts(Photoshop):
+    """An installed font."""
+
     def __init__(self, parent=None):
         super().__init__(parent=parent)
 
@@ -24,15 +26,15 @@ def length(self):
         """The number pf elements in the collection."""
         return len(self._fonts)
 
-    def getByName(self, name):
+    def getByName(self, name: str) -> TextFont:
         """Gets the font by the font name.
 
         Args:
-            name (str): The name of the font.
+            name: The name of the font.
 
 
         Returns:
-            Font
+            font instance.
 
         """
         for font in self.app:

photoshop/api/action_descriptor.py

@@ -18,6 +18,13 @@
 
 
 class ActionDescriptor(Photoshop):
+    """A record of key-value pairs for actions, such as those included on the Adobe Photoshop Actions menu.
+
+    The ActionDescriptor class is part of the Action Manager functionality.
+    For more details on the Action Manager, see the Photoshop Scripting Guide.
+
+    """
+
     object_name = "ActionDescriptor"
 
     def __init__(self):

photoshop/api/action_list.py

@@ -9,6 +9,14 @@
 
 
 class ActionList(Photoshop):
+    """The list of commands that comprise an Action.
+
+    (such as an Action created using the Actions palette in the Adobe Photoshop application).
+    The action list object is part of the Action Manager functionality.
+    For details on using the Action Manager, see the Photoshop Scripting Guide.
+
+    """
+
     object_name = "ActionList"
 
     def __init__(self, parent=None):

photoshop/api/action_reference.py

@@ -14,6 +14,13 @@
 
 
 class ActionReference(Photoshop):
+    """Contains data describing a referenced Action.
+
+    The action reference object is part of the Action Manager functionality.
+    For details on using the Action Manager, see the Photoshop Scripting Guide.
+
+    """
+
     object_name = "ActionReference"
 
     def __init__(self, parent=None):

photoshop/api/application.py

@@ -30,6 +30,13 @@
 
 
 class Application(Photoshop):
+    """The Adobe Photoshop application object, which contains all other Adobe Photoshop objects.
+
+    This is the root of the object model, and provides access to all other objects.
+    To access the properties and methods, you can use the pre-defined global variable app.
+
+    """
+
     def __init__(self, version=None):
         super().__init__(ps_version=version)
 

photoshop/api/event_id.py

@@ -3,6 +3,8 @@
 
 
 class EventID(str, Enum):
+    """All event ids."""
+
     # Here is a list of JSON CallBack events in Photoshop.
     # https://community.adobe.com/t5/get-started/photoshop-json-callback-events-list-up-to-cc2015-ver-16/td-p/4792115?page=1
     TDTransform = "TdT "

photoshop/api/solid_color.py

@@ -4,8 +4,7 @@
 
 - Used in `Application.backgroundColor` and `foregroundColor` properties, in
 `Channel.color`, in `ColorSampler.color`, and in `TextItem.color`
-- Passed to `PathItem.fillPath()`, `Selection.fill()`, and
-`Selection.stroke()`.
+- Passed to `PathItem.fillPath()`, `Selection.fill()`, and `Selection.stroke()`.
 
 """
 
@@ -20,6 +19,8 @@
 
 
 class SolidColor(Photoshop):
+    """A color definition used in the document."""
+
     object_name = "SolidColor"
 
     def __init__(self, parent=None):

photoshop/api/text_font.py

@@ -3,6 +3,8 @@
 
 
 class TextFont(Photoshop):
+    """An installed font."""
+
     def __init__(self, parent=None):
         super().__init__(parent=parent)
 

photoshop/api/text_item.py

@@ -13,6 +13,8 @@
 
 
 class TextItem(Photoshop):
+    """The text that is associated with the layer. Valid only when ‘kind’ is text layer."""
+
     object_name = "Application"
 
     def __init__(self, parent):