Welcome! Please see the About page for a little more info on how this works.

+5 votes
in Docs by
edited by

The docstring for get is:

Returns the value mapped to key, not-found or nil if key not present.

Multiple people at my work have found that sentence confusingly terse and hard to parse.

The docstring for get-in is:

Returns the value in a nested associative structure, where ks is a sequence of keys. Returns nil if the key is not present, or the not-found value if supplied.

Could the docstring for get be changed to:

Returns the value mapped to key. Returns nil if the key is not present, or the not-found value if supplied.

Logged and patch attached at: https://clojure.atlassian.net/browse/CLJ-2544

1 Answer

+1 vote
by
selected by
 
Best answer

Seems reasonable - logged at https://clojure.atlassian.net/browse/CLJ-2544 and attached a patch.

...