Zsh Mailing List Archive Messages sorted by: Reverse Date, Date, Thread, Author

Automatic code documentation – example for 2 Zsh functions

X-seq: zsh-workers 41934
From: Sebastian Gniazdowski <psprint@xxxxxxxxxxx>
To: zsh-workers@xxxxxxx
Subject: Automatic code documentation – example for 2 Zsh functions
Date: Thu, 19 Oct 2017 15:35:24 +0200
List-help: <mailto:zsh-workers-help@zsh.org>
List-id: Zsh Workers List <zsh-workers.zsh.org>
List-post: <mailto:zsh-workers@zsh.org>
List-unsubscribe: <mailto:zsh-workers-unsubscribe@zsh.org>
Mailing-list: contact zsh-workers-help@xxxxxxx; run by ezmlm

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

Follow-Ups:
- Re: Automatic code documentation – example for 2 Zsh functions
  - From: Sebastian Gniazdowski

Messages sorted by: Reverse Date, Date, Thread, Author