Clojure

def should support an optional doc-string

Details

  • Type: Enhancement Enhancement
  • Status: Closed Closed
  • Resolution: Completed
  • Affects Version/s: None
  • Fix Version/s: Release 1.3
  • Component/s: None
  • Labels:
    None
  • Approval:
    Ok

Description

To be more consistent across all "operators that introduce names", def should support an optional docstring after the name.

Activity

Hide
Assembla Importer added a comment -

bsteuber said: [file:cwJXMqr-Kr35PieJe5aVNr]

Show
Assembla Importer added a comment - bsteuber said: [file:cwJXMqr-Kr35PieJe5aVNr]
Hide
Assembla Importer added a comment -

bsteuber said: Contributor Agreement coming soon..

Show
Assembla Importer added a comment - bsteuber said: Contributor Agreement coming soon..
Hide
Assembla Importer added a comment -

bsteuber said: Now it arrived

Show
Assembla Importer added a comment - bsteuber said: Now it arrived
Hide
Assembla Importer added a comment -
Show
Assembla Importer added a comment - stu said: [file:bOM0ly1umr36tseJe5cbLA]
Hide
Assembla Importer added a comment -

stu said: Second patch subsumes first and adds some minor cleanup.

Show
Assembla Importer added a comment - stu said: Second patch subsumes first and adds some minor cleanup.
Hide
Assembla Importer added a comment -

stu said: Updating tickets (#276, #280, #378, #437, #448)

Show
Assembla Importer added a comment - stu said: Updating tickets (#276, #280, #378, #437, #448)
Hide
Benjamin Teuber added a comment -

In my initial patch, I forgot to update clojure.repl to have (doc def) mention the optional docstring. I've written a patch for this small doc update, but it seems I can't upload it anymore in a closed issue. Should I just mail it to someone?

Show
Benjamin Teuber added a comment - In my initial patch, I forgot to update clojure.repl to have (doc def) mention the optional docstring. I've written a patch for this small doc update, but it seems I can't upload it anymore in a closed issue. Should I just mail it to someone?
Hide
Stuart Halloway added a comment -

I made this change before seeing your comment.

Show
Stuart Halloway added a comment - I made this change before seeing your comment.
Hide
Benjamin Teuber added a comment -

I see - funny coincedence
My patch had the additional sentence

"An optional documentation string can be supplied (only when init is given, too)."

at the end of the documentation to be clear about what happens when only one of init and doc is given, but I'm not sure this really is necessary.

Loved your book by the way

Show
Benjamin Teuber added a comment - I see - funny coincedence My patch had the additional sentence "An optional documentation string can be supplied (only when init is given, too)." at the end of the documentation to be clear about what happens when only one of init and doc is given, but I'm not sure this really is necessary. Loved your book by the way

People

  • Assignee:
    Unassigned
    Reporter:
    Anonymous
Vote (0)
Watch (2)

Dates

  • Created:
    Updated:
    Resolved: