Summary

quickref mode for chicken-doc

Metadata

• Id: 2a6b303710f3978815e4c1d15e2dba24bb3748fc
• Trac id: 262
• Type: enhancement
• Reporter: felix
• Owner: zbigniew
• Cc:
• Status: closed
• Component: extensions
• Estimated difficulty:
• Resolution: worksforme
• Priority: not urgent at all
• Milestone:
• Version:
• Changetime: 2010-06-04 13:55:27 UTC
• Created: 2010-06-03 09:10:11 UTC
• Keywords: chicken-doc quickref

Description

This is a feature request.

It would be cool if `chicken-doc` could provide a "quickref" mode, where only procedures, macros and parameters (more?) are lised in alphabetical order, somewhat like this:

 path: ...
 
 (ask-for-nonconfirmation UNUSED POINTLESS)        ; syntax
 (behave-irrationally . MANY-ARGUMENTS)            ; procedure
 (consult-consultant [NAME])                       ; procedure
 :

Changes and comments

[2010-06-03 16:43:05 UTC] zbigniew wrote:

That does sound interesting, but could you explain how it differs from `chicken-doc -c path`?

That doesn't provide the node type information (syntax, procedure) as you requested, but that's only because it took up too much space.

 $ chicken-doc -c posix
 _exit                        (_exit [CODE])
 block-device?                (block-device? FILENAME)
 call-with-input-pipe         (call-with-input-pipe CMDLINE PROC [MODE])
 call-with-output-pipe        (call-with-output-pipe CMDLINE PROC [MODE])

[2010-06-04 13:55:27 UTC] felix changed status from new to closed

[2010-06-04 13:55:27 UTC] felix set resolution to worksforme

[2010-06-04 13:55:27 UTC] felix wrote:

Replying to zbigniew: > That does sound interesting, but could you explain how it differs from `chicken-doc -c path`? >

Oh - I thought, -c would also list subsections and such. Sorry, I wasn't aware of that.