Merge pull request #45 from avikpln/fix-missing-architecture

Update architecture diagram and conventions

Author: avikpln

ARCHITECTURE.md

@@ -8,23 +8,25 @@ and the relationships between its classes.
 ```mermaid
 classDiagram
     class Sequence~T~ {
+        %% Attributes
         +finite
         +first_index
         +last_index
         +size
+
+        %% Methods
         +combine(other, op)
         +head(size)
         +map(op)
         +shift_by(offset)
         +shift_to(where)
+        +subiter(start, stop, step)
         +subsequence(subrule, size)
         +tail(size)
-        +constant(value, size, first_index)$
-        +from_iterable(iterable, first_index)$
-        #_rule
     }
 
     class NumericSequence {
+        %% Methods
         +__add__(other)
         +__radd__(other)
         +__sub__(other)
@@ -42,19 +44,10 @@ classDiagram
         +__neg__()
         +__abs__()
         +map(op)
-        +euler()$
-        +geometric(first_term, common_ratio, size, first_index)$
-        +naturals(size, first_index)$
-        +progression(first_term, common_difference, size, first_index)$
     }
 
     Sequence <|-- NumericSequence
 
-    class Recurrence {
-        +basis
-        +order
-    }
-
     Sequence <|-- Recurrence
 
     NumericSequence <|-- NumericRecurrence
@@ -65,8 +58,6 @@ classDiagram
 
 ## Notes
 
-- `$` is used in this diagram to denote a static method. The static
-  methods shown here are factory methods.
 - `Sequence` is the base abstraction for sequences in the package.
 - `NumericSequence` inherits from `Sequence` and implements arithmetic
   operators through Python's special methods.

STYLE.md

@@ -250,3 +250,9 @@ All checks should pass before committing.
 This same sequence is automated by the project's CI workflow, which
 uses the empty-tree hash to check every file in the repository rather
 than just staged changes.
+
+## Architecture Diagrams
+
+-   Specify only public instance attributes and methods;
+-   Order members alphabetically unless grouping them has a meaningful
+    structural or conceptual purpose.

TODO.md

@@ -83,8 +83,5 @@
 
 - Should `BinarySequence`/`RandomSequence` abstractions be added?
 
-- Decide which protected members and nested classes should be
-  represented in `ARCHITECTURE.md`.
-
 - Should `{rₙ}` be used to denote `Recurrence` and `NumericRecurrence`
   instead of `{aₙ}`?