Skip to content
This repository has been archived by the owner on Jun 27, 2019. It is now read-only.

Suggestion: Separate syntax cheat sheet #36

Closed
arrdem opened this issue Jul 12, 2014 · 5 comments
Closed

Suggestion: Separate syntax cheat sheet #36

arrdem opened this issue Jul 12, 2014 · 5 comments

Comments

@arrdem
Copy link
Contributor

arrdem commented Jul 12, 2014

While the Clojure Cheatsheet has reader literal information, it could be worthwhile to have separate writeups of the macro syntax and of the reader literal syntax both of which have some intricacies.

@arrdem arrdem added this to the 0.3.1 milestone Jul 24, 2014
@robert-stuttaford
Copy link
Contributor

Perhaps @kouphax, author of http://yobriefca.se/blog/2014/05/19/the-weird-and-wonderful-characters-of-clojure/ would be willing to let Grimoire host a reference?

@arrdem
Copy link
Contributor Author

arrdem commented Aug 2, 2014

I'm pondering whether or not this falls in Grimoire's perview as being a quickreference tool. The piece you linked, while awesome, is definitely better suited to its long form than to anything which will appear on Grimoire's frontpage.

I note that the cheatsheet already has macros & reader literals.

I also note that the macro section of the cheathsheet doesn't link to the related symbols. This is arguably a cheatsheet bug. @jafingerhut will likely be getting a PR on this from me.

I'd suggest that the best way to do this is to expect that some future version of the cheatsheet will feature this syntax reference mapping, and to simply add appropriate macro expansion examples to the macro implementation fns which already have Grimoire pages.

@arrdem
Copy link
Contributor Author

arrdem commented Aug 2, 2014

Another interesting/weird point is that if you search for "#()" or "#{}", although they are textually present in the cheat sheet the search bar won't find them.

@arrdem
Copy link
Contributor Author

arrdem commented Aug 2, 2014

Other special characters such as ~, @, ~@, and ` exhibit the same behavior.

@arrdem
Copy link
Contributor Author

arrdem commented Oct 10, 2014

Closing as being too out of keeping with the direction of both the cheat sheet and augmented per-symbol documentation.

@arrdem arrdem closed this as completed Oct 10, 2014
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants