Several top-level forms have improperly-located docstrings

Key details

Description

A number of top-level forms have docstrings which are improperly-located within the defining form (viz. defn / defn- / defmacro), and thus are discarded rather than attached as proper metadata. I believe I have fixed all (10) instances within the project with my patch.

The following code demonstrates the problem and the efficacy of the patch:

(def doc-syms
  "Symbols missing documentation because it's incorrectly located
  within the defn / defn- / defmacro form."
  [#'clojure.core/group-by-sig
   #'clojure.pprint/setf
   #'clojure.pprint/unzip-map
   #'clojure.pprint/tuple-map
   #'clojure.pprint/rtrim
   #'clojure.pprint/ltrim
   #'clojure.pprint/prefix-count
   #'clojure.pprint/prerr
   #'clojure.pprint/prlabel
   #'clojure.set/bubble-max-key])

;; before patch
(every? nil?    (map (comp :doc meta) doc-syms)) ; => true

;; after patch
(every? string? (map (comp :doc meta) doc-syms)) ; => true

Prescreened by: Alex Miller

Environment

None

Attachments

			Delete or go to	Download
fix-improper-docstrings.patch	8 KB	29 May 2017 5:06pm

Activity

Cameron Desautels

May 30, 2017 at 4:47 PM

Alex Miller

May 30, 2017 at 2:59 PM

Cameron Desautels

May 30, 2017 at 5:01 AM

Cameron Desautels

May 30, 2017 at 4:55 AM

Andy Fingerhut

May 30, 2017 at 4:26 AM

Resize work item view side panel

Completed

Details

Assignee

Unassigned

Reporter

Cameron Desautels

Labels

docstring

Approval

Patch

Code

Priority

Minor

Affects versions

Release 1.9

Fix versions

Release 1.9

Created May 29, 2017 at 5:06 PM

Updated September 7, 2017 at 3:49 AM

Resolved September 7, 2017 at 3:49 AM