ID

72c0ade

date

2023-12-27 12:24:34+00:00

author

Alex Chan <alex@alexwlchan.net>

parent

a664799

message

Use Cog to generate the Flickr documentation

changed files

1 file, 33 additions, 2 deletions

• flickr/README.md

Changed files

flickr/README.md (589) → flickr/README.md (1336)

diff --git a/flickr/README.md b/flickr/README.md
index b95756a..e5299e0 100644
--- a/flickr/README.md
+++ b/flickr/README.md
@@ -4,6 +4,36 @@ These scripts do stuff with the Flickr API.
 
 ## The individual scripts
 
+<!-- [[[cog
+
+# This adds the root of the repo to the PATH, which has cog_helpers.py
+from os.path import abspath, dirname
+import sys
+
+sys.path.append(abspath(dirname(dirname("."))))
+
+import cog_helpers
+
+folder_name = "flickr"
+
+scripts = [
+    {
+        "usage": "flapi.sh [METHOD] [PARAMS]",
+        "description": """
+        call a method with the Flickr API and print the XML response to stdout.
+        """,
+    },
+    {
+        "usage": "flphoto.sh [PHOTO_ID]",
+        "description": """
+        look up a single photo with the Flickr API and print the XML response to stdout.
+        """,
+    },
+]
+
+cog_helpers.create_description_table(folder_name=folder_name, scripts=scripts)
+
+]]]-->
 <dl>
   <dt>
     <a href="https://github.com/alexwlchan/scripts/blob/main/flickr/flapi.sh">
@@ -13,13 +43,14 @@ These scripts do stuff with the Flickr API.
   <dd>
     call a method with the Flickr API and print the XML response to stdout.
   </dd>
-  
+
   <dt>
     <a href="https://github.com/alexwlchan/scripts/blob/main/flickr/flphoto.sh">
-      <code>flphoto.sh [METHOD] [PARAMS]</code>
+      <code>flphoto.sh [PHOTO_ID]</code>
     </a>
   </dt>
   <dd>
     look up a single photo with the Flickr API and print the XML response to stdout.
   </dd>
 </dl>
+<!-- [[[end]]] (checksum: 7d80deb90d125a1f886c6faa3436d829) -->