Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Online help for SRFIs? #351

Open
jpellegrini opened this issue Dec 20, 2021 · 0 comments
Open

Online help for SRFIs? #351

jpellegrini opened this issue Dec 20, 2021 · 0 comments

Comments

@jpellegrini
Copy link
Contributor

Hi @egallesio !

I was wondering if it'd be OK to have online help for SRFI procedures.

I have added help for one SRFI-217 procedure, just to see if it'd work.
The help when I search the symbol is always available, but if I search the procedure, then of course we need the SRFI loaded first:

stklos> (help 'iset?)
Help for iset?:
Documentation:
  (iset? obj)
  Returns |#t| is |obj| is an iset and |#f| otherwise.
stklos> (help iset?)
**** Error:
%execute: variable `iset?' unbound
	(type ",help" for more information)
stklos> (require "patricia")
"patricia"
stklos> (import stklos/patricia)
stklos> (help iset?)
Help for iset?:
Documentation:
  (iset? obj)
  Returns |#t| is |obj| is an iset and |#f| otherwise.

I'm not sure if adding documentation to all SRFIs wouldn't be too much in terms of space.

By the way, I have tried grepping DOCDB for iset and it's not there. So where is it stored?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant