LispCookbook / LispCookbook/cl-cookbook
emacs-ide.md is a little out of date
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 1.1k
- Forks
- 158
- Avg merge
- 6d 3h
- Merged PRs (30d)
- 2
Description
I suggest to update the following two points:
> Dynamic scope is everywhere
Elisp had had optional lexical binding for a decade by now, if not longer. `lexical-binding: t` is becoming the default right now, the topic is hot on emacs-devel.
With `lexical-binding` set to t, scoping in Elisp feels just like CL's. Some non-variable scoping is still dynamic under the hood but that mostly implies compiled code being slower than necessary, and is basically unnoticeable to most users.
I strongly suggest something like “Dynamic scope might pop unexpectedly here and there; however, this rapidly becomes an unlikely possibility, and compiler(s) warn about it since recently”, and moving it much closer to the end of the list of differences.
> There are no reader (or reader-related) functions
Not entirely true. There are reader-related functions; there is `read`, for example. It's just in C and the reader is not extensible with Elisp. The phrasing may confuse people.
See also https://github.com/mishoo/elisp-reader.el I didn't try it but I think it's worthy of mentioning, e.g.: “See, however, mishoo/elisp-reader.el”
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open emacs-ide.md and review the sections titled “Dynamic scope is everywhere” and “There are no reader (or reader-related) functions.” Update both explanations to reflect lexical-binding and the existence of read and reader-related functions, and consider mentioning mishoo/elisp-reader.el. Done means the two statements are accurate and the suggested reference is included where appropriate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- emacs, emacs-lisp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100