Procházet zdrojové kódy

docs: Add docstring to oneshot method

Cristian před 5 roky
rodič
revize
a8c74730f8
1 změnil soubory, kde provedl 4 přidání a 0 odebrání
  1. 4 0
      archivebox/main.py

+ 4 - 0
archivebox/main.py

@@ -496,6 +496,10 @@ def status(out_dir: str=OUTPUT_DIR) -> None:
 
 
 @enforce_types
 @enforce_types
 def oneshot(url: str, out_dir: str=OUTPUT_DIR):
 def oneshot(url: str, out_dir: str=OUTPUT_DIR):
+    """
+    Create a single URL archive folder with an index.json and index.html, and all the archive method outputs.
+    You can run this to archive single pages without needing to create a whole collection with archivebox init.
+    """
     oneshot_link, _ = parse_links_memory([url])
     oneshot_link, _ = parse_links_memory([url])
     if len(oneshot_link) > 1:
     if len(oneshot_link) > 1:
         stderr(
         stderr(