cl-community-spec icon indicating copy to clipboard operation
cl-community-spec copied to clipboard

ANSI Standard Errata

Open olnw opened this issue 2 years ago • 3 comments

CLiki lists many errors in the ANSI standard, and some of them are quite glaring. For instance, SETQ is described as a "special form" rather than "special operator". Is it outside the scope of this project to amend these errors?

https://www.cliki.net/ANSI%20Clarifications%20and%20Errata

The readme states:

The content is left unchanged at this stage*, the only work right now goes into the presentation.

Which seems to imply a possibility of this being addressed.

olnw avatar Sep 11 '23 02:09 olnw

I probably won't add any notes/modifications myself. But as I wrote in https://github.com/fonol/cl-community-spec/issues/15 contributions are welcome. I just would like to somehow mark the changed content. In this case I guess it could be done by correcting the title and adding a "Community Note" or "Errata" or sth like that at the bottom with a remark that the title has been changed. The workflow to change content is a bit wonky right now, but if you still want to do it, you can proceed as follows:

  1. Replace the occurrences of "Special Form" in html_in/setq.html by "Special Operator".
  2. Add a new section before the end of the element, that looks like described in #15. This will appear as a card in the generated HTML.
  3. Run convert.py. The updated file should be in html_out

fonol avatar Sep 11 '23 18:09 fonol

Thanks, I just made a PR: https://github.com/fonol/cl-community-spec/pull/18 When I ran the python script, it appeared to modify all files in html_out. Is that normal? I just committed my changes to setq.html in the PR.

Maybe it's a good idea to leave this issue open for further discussion of errata in the standard?

olnw avatar Sep 12 '23 12:09 olnw

Thanks, I merged and it should be online in a few minutes. And yes, it always touches all the files on each run (but actually only should modify the others if you changed a link or a page title). I'll leave the issue open! :)

fonol avatar Sep 12 '23 12:09 fonol