Skip to content

Commit 28fdd7b

Browse files
committed
Prep for next release
Probably a good idea to bump minor as we are deprecating some fns in paredit. And have also made significant changes to this API. Add a warning about paredit being under development.
1 parent e3038e7 commit 28fdd7b

File tree

3 files changed

+11
-6
lines changed

3 files changed

+11
-6
lines changed

deps.edn

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
:aliases {;; we use babashka/neil for project attributes
77
;; publish workflow references these values (and automatically bumps patch component of version)
8-
:neil {:project {:version "1.1.49" ;; describes last release and is template for next release
8+
:neil {:project {:version "1.2.49" ;; describes last release and is template for next release
99
:name rewrite-clj/rewrite-clj
1010
;; not neilisms - could potentially conflict with new neilisms
1111
:github-coords clj-commons/rewrite-clj}}

doc/01-user-guide.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -688,7 +688,9 @@ Finally, there are a handful of node whitespace creation convenience functions s
688688
=== Paredit API
689689
Structured editing was introduce by rewrite-cljs and carried over to rewrite-clj v1.
690690

691-
We might expand this section if there is interest, but the docstrings should get you started.
691+
We have plans to expand this section but the docstrings should get you started.
692+
693+
WARNING: The paredit API is experimental, under development, and subject to change.
692694

693695
See link:{cljdoc-api-url}/rewrite-clj.paredit[current paredit API docs].
694696

src/rewrite_clj/paredit.cljc

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
(ns rewrite-clj.paredit
22
"Paredit zipper operations for Clojure/ClojureScript/EDN.
33
4+
> [!WARNING]
5+
> This API is experimental, under development, and subject to change.
6+
47
You might find inspiration from examples here: https://pub.gajendra.net/src/paredit-refcard.pdf"
58
(:require [clojure.string :as str]
69
[rewrite-clj.custom-zipper.core :as zraw]
@@ -351,7 +354,7 @@
351354
(z/append-child (z/node slurpee-loc)) ;; slurp in slurpee
352355
(nav-via route)))))))
353356

354-
(defn ^{:deprecated "1.1.49"} slurp-forward
357+
(defn ^{:deprecated "1.2.50"} slurp-forward
355358
"DEPRECATED: we recommend [[slurp-forward-into]] instead for more control.
356359
357360
Return `zloc` with node to the right of nearest eligible sequence slurped into that sequence else `zloc` unchanged.
@@ -415,7 +418,7 @@
415418
(take (inc n-slurps))
416419
last))))))
417420

418-
(defn ^{:deprecated "1.1.49"} slurp-forward-fully
421+
(defn ^{:deprecated "1.2.50"} slurp-forward-fully
419422
"DEPRECATED: We recommend [[slurp-forward-fully-into]]] for more control.
420423
421424
Return `zloc` with all right sibling nodes of nearest eligible sequence slurped into that sequence else `zloc` unchanged.
@@ -478,7 +481,7 @@
478481
(z/insert-child (z/node slurpee-loc))
479482
(nav-via route)))))))
480483

481-
(defn ^{:deprecated "1.1.49"} slurp-backward
484+
(defn ^{:deprecated "1.2.50"} slurp-backward
482485
"DEPRECATED: we recommend [[slurp-backward-into]] for more control.
483486
484487
Returns `zloc` with node to the left of nearest eligible sequence slurped into that sequence else `zloc` unchanged.
@@ -543,7 +546,7 @@
543546
(take (inc n-slurps))
544547
last))))))
545548

546-
(defn ^{:deprecated "1.1.49"} slurp-backward-fully
549+
(defn ^{:deprecated "1.2.50"} slurp-backward-fully
547550
"DEPRECATED: We recommend instead [[slurp-backward-fully-into]] for more control.
548551
549552
Returns `zloc` with all left sibling nodes of nearest eligible sequnece slurped into that sequence else `zloc`.

0 commit comments

Comments
 (0)