docs: update docstrings of derived SystematicBlockCodes

rwnobrega · Dec 26, 2024 · 04a26fd · 04a26fd
1 parent ab1f604
commit 04a26fd
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/src/komm/_error_control_block/GolayCode.py b/src/komm/_error_control_block/GolayCode.py
@@ -41,7 +41,7 @@ class GolayCode(SystematicBlockCode):
     Attributes:
         extended: If `True`, constructs the code in extended version. The default value is `False`.
 
-    This function returns the code in systematic form, with the information set on the left.
+    This class represents the code in [systematic form](/ref/SystematicBlockCode), with the information set on the left.
 
     Examples:
         >>> code = komm.GolayCode()

diff --git a/src/komm/_error_control_block/HammingCode.py b/src/komm/_error_control_block/HammingCode.py
@@ -37,7 +37,7 @@ class HammingCode(SystematicBlockCode):
         mu: The parameter $\mu$ of the code. Must satisfy $\mu \geq 2$.
         extended: Whether to use the extended version of the Hamming code. Default is `False`.
 
-    This function returns the code in systematic form, with the information set on the left.
+    This class represents the code in [systematic form](/ref/SystematicBlockCode), with the information set on the left.
 
     Examples:
         >>> code = komm.HammingCode(3)

diff --git a/src/komm/_error_control_block/SimplexCode.py b/src/komm/_error_control_block/SimplexCode.py
@@ -31,7 +31,7 @@ class SimplexCode(SystematicBlockCode):
         kappa: The parameter $\kappa$ of the code. Must satisfy $\kappa \geq 2$.
         extended: Whether to use the extended version of the Simplex code. Default is `False`.
 
-    This function constructs the code in systematic form, with the information set on the left.
+    This class represents the code in [systematic form](/ref/SystematicBlockCode), with the information set on the left.
 
     Examples:
         >>> code = komm.SimplexCode(3)