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

independent examples? (for eg rendering in emacs help) #7

Open
mooseyboots opened this issue Feb 3, 2025 · 1 comment
Open

independent examples? (for eg rendering in emacs help) #7

mooseyboots opened this issue Feb 3, 2025 · 1 comment

Comments

@mooseyboots
Copy link

hi,

this looks like a great project! i'm a learner and often struggle to come at the hyperspec. (while working, i tend to reach for resources like https://lispcookbook.github.io/cl-cookbook/.)

i wonder if the examples being added here are or could be made accessible directly from a CL REPL? I use emacs, so SLIME or SLY in my case. I often find that the documentation there is lacking (notoriously, that of loop, but others also), so I often need to reach for an additional web resource of some kind for brief explanation and usage examples.

I'm thinking of something like the elisp-demos package in emacs, which provides Elisp examples inside its lookup/help system (underneath the standard documentation elements). With something like that for CL you could have examples in your editor as you work.

or perhaps there's another way to achieve such a thing? I haven't found one yet...

@daninus14
Copy link
Contributor

Hi, I've heard people talking about it in the common lisp or emacs reddits. Though I haven't done much with emacs or sly/slime extensions.

You are welcome to use the content for whatever you want. It has an MIT license. I would appreciate it if you could add a link to the source to encourage people to contribute, but that's up to you.

For the examples, note that there are two different projects in lisp-docs. One is a tutorial and the other one if the reference. The reference has the original standard specification, and has an "Expanded Reference" section with examples. Those are usually almost standalone files. The spec files are usually imported into the main file which contains the extended reference, so it should be fairly simple to get the content from the title of "Expanded Reference" and on for each file. You could even just do it as a script without editing anything manually so that you can always pull the latest changes. Though I cannot guarantee that the file structure will be maintained, it probably will.

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

2 participants