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

Minor fixes for iteration, style guide, front page, etc #545

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

cgay
Copy link
Contributor

@cgay cgay commented Jun 13, 2024

applies to #540

cgay added 5 commits June 13, 2024 16:01
This could be "for the beginner as well as for the advanced developer" or "as
much for the beginner as for the more advanced developer", but this seemed the
most direct and least "wordy" change.
@vindarel
Copy link
Contributor

that's grand, thanks.

We have to talk about code snippets starting with * , I really don't like them: beginners wonder what this is, more tedious to copy-paste, ugly, less explicit than CL-USER> . I would not have any prompt (so the styleguide isn't clear on this, but it doesn't mention prompt strings^^).

oh, I see you also uncommented the results, which makes sense when using * .

so instead of

(map 'vector (lambda (it) (+ it 10)) '(1 2 3))
;; #(11 12 13)

we now have

* (map 'vector (lambda (it) (+ it 10)) '(1 2 3))
#(11 12 13)

this is undoing edits I made for this.

(for long results we can use a => without ;; afterwards)

@cgay
Copy link
Contributor Author

cgay commented Jun 13, 2024

ok, that makes sense. Just to make sure I understand correctly, you're saying you would prefer

(some lisp form)
;; result value 1
;; result value 2

?

Or we could go with this, perhaps a little clearer?

(some lisp form)
;; => result value 1
;; => result value 2

@vindarel
Copy link
Contributor

option 1) is used throughout the Cookbook, option 2) is good, we can go with it.

With long results, we can do

(some lisp form)
;; =>
;; 1
;; 2
;; 3

but also

(some lisp form)
;; =>
(some
   result
   form/s)

(this allows to see syntax highlighting for the result when appropriate)

and also a separate code block for the result.

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

Successfully merging this pull request may close these issues.

None yet

2 participants