Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

Document behavior of clojure.core/get on strings and Java arrays

Description

Problem

The get function does not document the behavior when given a String or Array instance.

Context

get's implementation checks in order for

  • ILookup

  • nil

  • Map

  • IPersistentSet

  • String or Java array

The docstring for get currently reads

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

That this works on maps and associative data can reasonably be inferred if one knows Clojure's data model. That it works on sets, Strings, and arrays is less obvious, and would be helpful to mention.

Proposed: New docstring for get:

Returns the value mapped to key, not-found or nil if key not present in associative collection, set, string, or array.

Patch: clj-2249-5.patch

Screened by: Alex Miller

Environment

None

Attachments

5
  • 18 Nov 2021, 03:42 PM
  • 05 Oct 2021, 04:23 PM
  • 04 Oct 2018, 08:12 PM
  • 09 Oct 2017, 09:27 AM
  • 05 Oct 2017, 06:47 PM

Activity

Show:

Alex Miller November 23, 2021 at 8:43 PM

Released in 1.11.0-alpha3

Rich Hickey November 18, 2021 at 2:36 PM

I would add “or ILookup instance” since that is the minimal path to get.

Alex Miller October 5, 2021 at 4:24 PM

Added -4 patch and updated ticket to include proposed docstring

Rich Hickey September 14, 2021 at 12:52 PM

“Returns the value mapped to key, not-found or nil if key not present+ on indexed collections (including strings and arrays) and on sets by+ value.” makes it sound like it only works on indexed collections. Maps are not Indexed.

Alex Miller October 4, 2018 at 8:12 PM

Reworked docstring addition a bit

Fixed

Details

Assignee

Reporter

Labels

Approval

Ok

Patch

Code

Priority

Fix versions

Created October 5, 2017 at 6:47 PM
Updated November 23, 2021 at 8:43 PM
Resolved November 23, 2021 at 6:29 PM

Flag notifications