adding more detials to parfile_notes.md

lanl · Feb 22, 2025 · 40068a6 · 40068a6
1 parent 4294188
commit 40068a6
Showing 1 changed file with 49 additions and 24 deletions.
diff --git a/src/pleiades/sammy/notes/parfile_notes.md b/src/pleiades/sammy/notes/parfile_notes.md
@@ -31,33 +31,58 @@
 
 ## Enums
 - CardOrder
-  - Methods
-    - get_field_name
+    - Methods
+        - get_field_name
 
 ## Classes
 - SammyParameterFile
-  - Attributes
-    - fudge
-    - resonance
-    - external_r
-    - broadening
-    - unused_correlated
-    - normalization
-    - radius
-    - data_reduction
-    - orres
-    - paramagnetic
-    - user_resolution
-    - isotope
-  - Methods
-    - to_string
-    - _get_card_class_with_header
-    - from_string
-    - _parse_card
-    - _get_card_class
-    - from_file
-    - to_file
-    - print_parameters
+    - Attributes
+        - fudge
+        - resonance
+        - external_r
+        - broadening
+        - unused_correlated
+        - normalization
+        - radius
+        - data_reduction
+        - orres
+        - paramagnetic
+        - user_resolution
+        - isotope
+    - Methods
+        - to_string
+            - Returns: str
+        - _get_card_class_with_header
+            @classmethod
+            - Parameters:
+                - header: str
+            - Returns: Type[BaseModel]
+        - from_string 
+            @classmethod
+            - Parameters:
+                - data: str
+            - Returns: SammyParameterFile
+        - _parse_card
+            @classmethod
+            - Parameters:
+                - card_data: str
+            - Returns: BaseModel
+        - _get_card_class
+            @classmethod
+            - Parameters:
+                - card_name: str
+            - Returns: Type[BaseModel]
+        - from_file 
+            @classmethod
+            - Parameters:
+                - file_path: Union[str, pathlib.Path]
+            - Returns: SammyParameterFile
+        - to_file
+            - Parameters:
+                - file_path: Union[str, pathlib.Path]
+        - print_parameters
+            - Parameters:
+                - None
 
 ## Main Function
 - Example usage