Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docstrings of java-time.api contain literal \n #111

Open
devurandom opened this issue May 31, 2024 · 3 comments · May be fixed by #113
Open

docstrings of java-time.api contain literal \n #111

devurandom opened this issue May 31, 2024 · 3 comments · May be fixed by #113

Comments

@devurandom
Copy link

The docstrings in java-time.api contain literal \n instead of newlines, which makes them hard to read in code. Cursive does not display them nicely either, but shows the documentation with the literal \n.
@devurandom
Copy link
Author

I looked at

clojure.java-time/test/java_time/dev/gen.clj

Lines 193 to 217 in cd06539

(defn print-form [form]
(with-bindings
(cond-> {#'*print-meta* true
#'*print-length* nil
#'*print-level* nil}
(resolve '*print-namespace-maps*)
(assoc (resolve '*print-namespace-maps*) false))
(cond
(string? form) (println form)
:else (println (pr-str (walk/postwalk
(fn [v]
(if (meta v)
(if (symbol? v)
(vary-meta v #(not-empty
(cond-> (sorted-map)
(some? (:tag %)) (assoc :tag (:tag %))
(some? (:doc %)) (assoc :doc (:doc %))
((some-fn true? string?) (:deprecated %)) (assoc :deprecated (:deprecated %))
(string? (:superseded-by %)) (assoc :superseded-by (:superseded-by %))
(string? (:supercedes %)) (assoc :supercedes (:supercedes %))
(some? (:arglists %)) (assoc :arglists (list 'quote (doall (map normalize-argv (:arglists %))))))))
(with-meta v nil))
v))
form)))))
nil)
and after some experimentation on the REPL I believe this might work:

(deftype DocString [value])

(defmethod print-method DocString
 [^DocString this ^Writer w]
 (.write w (str "\"" (.-value this) "\"")))

With this, the following code (modelled after java-time.dev.gen/print-form):

(with-bindings {#'*print-meta* true}
 (println (pr-str (with-meta {:value "X"} {:doc (DocString. "multi\nline\nstring")}))))

prints:

^{:doc "multi
line
string"} {:value "X"}

@frenchy64
Copy link
Collaborator

frenchy64 commented Aug 1, 2024 •
edited
Loading

Could you submit a PR we can collaborate on please?

devurandom added a commit to devurandom/clojure.java-time that referenced this issue Aug 2, 2024
@devurandom
Emit newlines instead of \n in docstrings
f8a7bb4 
Closes: dm3#111
@devurandom devurandom linked a pull request Aug 2, 2024 that will close this issue
Open
devurandom added a commit to devurandom/clojure.java-time that referenced this issue Aug 2, 2024
@devurandom
Emit newlines instead of \n in docstrings
291c825 
Closes: dm3#111
@devurandom
Copy link
Author

Could you submit a PR we can collaborate on please?

#113

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Emit newlines instead of \n in docstrings devurandom/clojure.java-time
2 participants
@devurandom @frenchy64