<< Back to previous view

[CLJ-936] Improve docs about argument destructuring at clojure.org Created: 21/Feb/12  Updated: 01/Mar/13  Resolved: 27/Nov/12

Status: Closed
Project: Clojure
Component/s: None
Affects Version/s: None
Fix Version/s: Release 1.5

Type: Enhancement Priority: Minor
Reporter: Jakub Holy Assignee: Unassigned
Resolution: Completed Votes: 0
Labels: documentation, web

Approval: Accepted

 Description   

What:
Make the description of argument destructuring more visible at http://clojure.org/special_forms, namely:

  • add a heading such as "<h4>Binding Forms (Argument Destructuring)</h4>" to the section describing it
  • make all occurences of "binding-form" a link to that heading, especially under the let and fn headings
  • for (fn ..) add a new second paragraph like "Regarding binding forms, also known as argument destructuring, <a href=#thea-new-heading>read more in the binding forms section</a> under the let special form."

Why:
It was always surprisingly difficult for me to google out the explanation of destructuring in Clojure and only today have I discovered that it is described pretty well under the let special form. Thus it should be made more visible to the readers (and preferably also search engines). (Even though Google has returned the page as one of the first matches, I had problems seeing it there - partly due to usually mistyping destructuring e.g. as deconstruction).

Thanks a lot!

PS: I haven't found a better way to report this, such as a commenting capability on the page itself.



 Comments   
Comment by Andy Fingerhut [ 12/Mar/12 6:03 PM ]

Jakub, I don't think I have authorization to edit those web pages in the way you suggest. I did want to comment that the most recent version of the Clojure cheatsheet at http://clojure.org/cheatsheet now has a link called "examples" in the "Special Forms" section that links to the 'let' section of the special forms documentation page.

Generated at Thu Oct 30 11:49:15 CDT 2014 using JIRA 4.4#649-r158309.