PYDOC3.12(1)

💖 NAME 💖

pydoc3.12 — the Python documentation tool, bestie. it's giving "I know everything about your code" and honestly? slay.

---

✨ SYNOPSIS ✨

pydoc3.12 name

pydoc3.12 -k keyword

pydoc3.12 -p port

pydoc3.12 -g

pydoc3.12 -w module [...]

---

🌸 DESCRIPTION 🌸

okay so here's the tea, one mode at a time 🫖

🦋 pydoc3.12 name

Show text documentation on something. that's it, that's the vibe.

and what even is name, you ask? great question, bestie 💅 it may be the name of a:

• Python keyword
• topic
• function
• module
• package

…or a dotted reference to a class or function within a module, or a module in a package. iykyk.

now here's the plot twist 😭 if name contains a /, it gets used as the path to a Python source file to document. like, a whole file. periodt.

and if name is keywords, topics, or modules? then you get a listing of these things displayed. a little menu of options, very demure, very mindful 🌈

🔍 pydoc3.12 -k keyword

Search for a keyword in the synopsis lines of all available modules.</purl>

wait that tag broke, let me try again — Search for a keyword in the synopsis lines of all available modules. 💜

it's a search. across all the modules. go find your little word, bestie.

🌐 pydoc3.12 -p port

Start an HTTP server on the given port on the local machine.</purl>

ok again — Start an HTTP server on the given port on the local machine. 🔥 your docs, but in a browser, on your machine. main character energy fr fr.

🎀 pydoc3.12 -g

Pop up a graphical interface for finding and serving documentation.

a whole GUI. for docs. we love a visual moment ✨

📝 pydoc3.12 -w name [...]

Write out the HTML documentation for a module to a file in the current directory.

so it writes a file. in the current directory. HTML. no cap.

and the same / rule applies here too, but slightly different — pay attention bestie 🙈 if name contains a /, it is treated as a filename; and if it names a directory, documentation is written for all the contents.

🚨 not me stressing this: the / behaviour is not identical across modes. in the name mode it's a path to a source file. in -w mode it's a filename, and a directory means "do all of it." keep them separate in your brain, okay? 🧠

---

👑 AUTHOR 👑

Moshe Zadka, based on "pydoc --help" 🫶 an icon, a legend, and apparently the moment.

---

and that's the whole page, bestie!! 💖 this was PYDOC3.12(1) from the General Commands Manual — thanks for reading all the way to the bottom, you're literally the main character 🎀✨💅