Uploaded image for project: 'Clojure'
  1. CLJ-1385

Docstrings for `conj!` and `assoc!` should suggest using the return value; effect not always in-place

    Details

    • Approval:
      Incomplete
    • Patch:
      Code

      Description

      The docstrings of both `assoc!` and `conj!` say "Returns coll.", possibly suggesting the transient edit happens (always) in-place, `coll` being the first argument. However, this is not the case and the returned collection should always be the one that's used.

      Approach: Replace "Returns coll." with "Returns an updated collection." in `conj!`, `assoc!`, `pop!` docstrings.

      Patch: CLJ-1385-reword-docstrings-on-transient-update-funct-2.patch

      Screened by: Alex Miller

        Attachments

          Activity

            People

            • Assignee:
              alexmiller Alex Miller
              Reporter:
              alex+import import
            • Votes:
              4 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated: