From a8c74730f8cf4658c530e21701f007ce01ab828f Mon Sep 17 00:00:00 2001
From: Cristian <cristian@swapps.com>
Date: Fri, 31 Jul 2020 10:28:30 -0500
Subject: [PATCH] docs: Add docstring to oneshot method

---
 archivebox/main.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/archivebox/main.py b/archivebox/main.py
index cd49d68b..1b58ad17 100644
--- a/archivebox/main.py
+++ b/archivebox/main.py
@@ -496,6 +496,10 @@ def status(out_dir: str=OUTPUT_DIR) -> None:
 
 @enforce_types
 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])
     if len(oneshot_link) > 1:
         stderr(