Skip to content

Commit fdab141

Browse files
committed
[#181] Add a couple of bad examples
1 parent 1ef0c84 commit fdab141

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1907,6 +1907,8 @@ was deprecated in case of versioned software (e.g. a library) or simply
19071907

19081908
[source,clojure]
19091909
----
1910+
;;; good
1911+
;;
19101912
;; in case we have a version
19111913
(def ^{:deprecated "0.5"} foo
19121914
"Use `bar` instead.
@@ -1922,6 +1924,16 @@ was deprecated in case of versioned software (e.g. a library) or simply
19221924
;; otherwise
19231925
(defn ^:deprecated foo
19241926
(bar))
1927+
1928+
;;; bad
1929+
;;
1930+
;; using the docstring to signal deprecation
1931+
(def foo
1932+
"DEPRECATED: Use `bar` instead.
1933+
42)
1934+
1935+
(ns foo.bar
1936+
"DEPRECATED: A deprecated ns.")
19251937
----
19261938

19271939
TIP: If you're into SemVer, it's a good idea to omit the patch version.

0 commit comments

Comments
 (0)