Merge pull request #18 from kamurani/patch-1

Add docstring help to download af cif func
MannLabs · Jan 8, 2024 · 2d02723 · 2d02723
2 parents 6215431 + 0b09207
commit 2d02723
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/structuremap/processing.py b/structuremap/processing.py
@@ -46,6 +46,10 @@ def download_alphafold_cif(
         download the structures.
     out_folder : str
         Path to the output folder.
+    out_format : str
+        The default file name of the cif files to be saved.
+        The brackets {} are replaced by a protein name from the proteins list.
+        Default is '{}.cif'.
     alphafold_cif_url : str
         The base link from where to download cif files.
         The brackets {} are replaced by a protein name from the proteins list.
@@ -119,7 +123,7 @@ def download_alphafold_pae(
     out_folder : str
         Path to the output folder.
     out_format : str
-        The default file name of the cif files to be saved.
+        The default file name of the pae files to be saved.
         The brackets {} are replaced by a protein name from the proteins list.
         Default is 'pae_{}.hdf'.
     alphafold_pae_url : str