diff --git a/README.adoc b/README.adoc index 23da53b..b888015 100644 --- a/README.adoc +++ b/README.adoc @@ -1,6 +1,6 @@ :notitle: // num-contributors is updated automatically by doc-readme-update bb task -:num-contributors: 54 +:num-contributors: 55 :figure-caption!: :imagesdir: ./doc :project-src-coords: clj-commons/rewrite-clj @@ -133,6 +133,7 @@ image:fazzone.png[fazzone,role="left",width=250,link="https://github.com/fazzone image:ferdinand-beyer.png[ferdinand-beyer,role="left",width=250,link="https://github.com/ferdinand-beyer"] image:green-coder.png[green-coder,role="left",width=250,link="https://github.com/green-coder"] image:guoyongxin.png[guoyongxin,role="left",width=250,link="https://github.com/guoyongxin"] +image:ikappaki.png[ikappaki,role="left",width=250,link="https://github.com/ikappaki"] image:immoh.png[immoh,role="left",width=250,link="https://github.com/immoh"] image:ivarref.png[ivarref,role="left",width=250,link="https://github.com/ivarref"] image:luxbock.png[luxbock,role="left",width=250,link="https://github.com/luxbock"] diff --git a/doc/01-user-guide.adoc b/doc/01-user-guide.adoc index 75e8efd..1913c51 100644 --- a/doc/01-user-guide.adoc +++ b/doc/01-user-guide.adoc @@ -702,9 +702,16 @@ This is convenient when navigating through the source, but when we want to logic == Parsing Peculiarities -Rewrite-clj can, in some specific cases, parse technically invalid Clojure. +Rewrite-clj might suprise Windows users and can, in some specific cases, parse technically invalid Clojure. Some folks have come to rely on this over the years, so these are behaviours we will preserve. +=== Newlines Always Normalize to `\n` +Window users might be suprised that `\r\n` newlines are converted to `\n` by rewrite-clj. + +Rewrite-clj makes use of https://github.com/clojure/tools.reader[Clojure's tools.reader] to parse Clojure code. +The `tools.reader` normalizes all recognized newline variants to `\n`. +Rewrite-clj picks up this behaviour. + [[unbalanced-maps]] === Unbalanced Maps An unbalanced map is one where there is a key with no value. diff --git a/doc/contributors.edn b/doc/contributors.edn index 09fce5c..dd1de65 100644 --- a/doc/contributors.edn +++ b/doc/contributors.edn @@ -99,7 +99,9 @@ {:github-id "NoahTheDuke" :contributions [:issue :encouragement]} {:github-id "ferdinand-beyer" - :contributions [:code-rewrite-clj-v1]}] + :contributions [:code-rewrite-clj-v1]} + {:github-id "ikappaki" + :contributions [:issue]}] :founders [{:github-id "xsc" :contributions [:original-author :doc :design :issue :review :support :code-rewrite-clj-v0]} diff --git a/doc/generated/contributors/ikappaki.png b/doc/generated/contributors/ikappaki.png new file mode 100644 index 0000000..b5871ec Binary files /dev/null and b/doc/generated/contributors/ikappaki.png differ