From: Sebastian Gniazdowski <psprint@zdharma.org>
To: zsh-workers@zsh.org
Subject: Automatic code documentation – example for 2 Zsh functions
Date: Thu, 19 Oct 2017 15:35:24 +0200 [thread overview]
Message-ID: <etPan.59e8aa1d.5dde9652.98a8@zdharma.org> (raw)
Hello,
using Zshelldoc I've generated code documentation for functions: tetris, tetriscurses. I encourage to read the docs a little to obtain quickly appearing hints, confirming that the docs are useful. Sadly no function is documented in both scripts, Zshelldoc would include comments preceding functions in result.
The docs in question:
https://github.com/zdharma/hacking-private/tree/master/auto-doc
So I thought that maybe there are functions in distribution that would be good to document this way? I'm successfully using Zshelldoc with 2 my projects zplugin, zplugin-crasis, also deploying PDFs with Travis CI to Github pages, etc.
Zshelldoc is here: https://github.com/zdharma/zshelldoc
BTW. Something happened to tetriscurses. I've observed this long time ago (1 year) but didn't have time to investigate – after starting, the blocks fall so fast that the game is over after about 0.1 second.
--
Sebastian Gniazdowski
psprint /at/ zdharma.org
next reply other threads:[~2017-10-19 13:35 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-10-19 13:35 Sebastian Gniazdowski [this message]
2017-10-19 15:32 ` Sebastian Gniazdowski
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=etPan.59e8aa1d.5dde9652.98a8@zdharma.org \
--to=psprint@zdharma.org \
--cc=zsh-workers@zsh.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.vuxu.org/mirror/zsh/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).