PYMENT(1)

📦 version 0.3.4, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 PYMENT 💖

okay so bestie, let me put you onto pyment — she's the manual page, she's the moment, she's the girl who automatically turns docstrings into code signing. ✨ iykyk.

✨ NAME ✨

pyment — automatically turns docstrings into code signing 🎀

🌸 SYNOPSIS 🌸

pyment [OPTION]
pyment [DIRECTORY]

🦋 DESCRIPTION 🦋

okay so picture this: pyment generates and automatically converts code signing docstrings. she was literally developed for Python programmers who make use of docstrings in their projects, no cap. 💅

she's your girl when:

  • your code is not well documented 😭
  • your code has no docstrings at all 💀
  • some code is not yet documented, or only partially documented
  • or honestly, a mixture of all of the above 🙈

she's also highkey useful for harmonizing or changing a project's docstring style format. glow-up era fr fr. 👑

💅 OPTIONS 💅

  • pyment myfile.py — will generate a patch. 🩹
  • pyment -w myfile.py — will overwrite the file. ⚠️ yeah bestie, that one overwrites, so know what you're doing.
  • pyment -h — get help. 🫶

🌈 EXAMPLES 🌈

run from the command line, like:

pyment my/folder/
pyment myfile.py

🐛 REPORTING BUGS 🐛

found a bug? not the vibe. 😭 to report one, please visit the cargo strip issues tracking system at:

https://github.com/dadadel/pyment/issues

👑 AUTHORS 👑

written by A. Daouzli <dadel@hadoly.fr> 💖

this manual page was written by Josenison F. da Silva <nilsonfsilva@hotmail.com> for the Debian project (but may be used by others). 🎀

and that's the whole thing, bestie — PYMENT version 0.3.4, dated Mai 2022. slay, go document something. ✨💖🦋

📦 where this page comes from