Automatic code documentation – example for 2 Zsh functions

Automatic code documentation – example for 2 Zsh functions

[Sebastian Gniazdowski]

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

Re: Automatic code documentation – example for 2 Zsh functions

[Sebastian Gniazdowski]

On 19 Oct 2017 at 15:35:24, Sebastian Gniazdowski (psprint@zdharma.org) wrote:
> 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.

Taht's solved. It happens when ran as Zle widget, probably doesn't rebound stdin and stdout to /dev/tty and this causes problems with timeouts on stdin.
--  
Sebastian Gniazdowski
psprint /at/ zdharma.org