improved doc

jlangch · Oct 4, 2023 · 847768d · 847768d
1 parent 9b312ce
commit 847768d
Showing 1 changed file with 8 additions and 7 deletions.
diff --git a/src/main/java/com/github/jlangch/venice/impl/functions/ConcurrencyFunctions.java b/src/main/java/com/github/jlangch/venice/impl/functions/ConcurrencyFunctions.java
@@ -155,7 +155,7 @@ else if (delegate instanceof Delay) {
                         "  (try-with [l (acquire l)]  \n" +
                         "     ;; do something         \n" +
                         "     ))                       ")
-                    .seeAlso("acquire", "release")
+                    .seeAlso("acquire", "try-acquire", "release", "locked?", "lock?")
                     .build()
         ) {
             @Override
@@ -179,7 +179,7 @@ public VncVal apply(final VncList args) {
                     .examples(
                         "(let [l (lock)]     \n" +
                         "  (lock? l))        ")
-                    .seeAlso("acquire", "release")
+                    .seeAlso("acquire", "try-acquire", "release", "locked?")
                     .build()
         ) {
             @Override
@@ -206,7 +206,7 @@ public VncVal apply(final VncList args) {
                         "  (acquire l)           \n" +
                         "  ;; do something       \n" +
                         "  (release l))          ")
-                    .seeAlso("lock", "release")
+                    .seeAlso("lock", "try-acquire", "release", "locked?")
                     .build()
         ) {
             @Override
@@ -243,7 +243,7 @@ public VncVal apply(final VncList args) {
                         "    ;; do something                    \n" +
                         "    (release l)))                      ")
 
-                    .seeAlso("lock", "release")
+                    .seeAlso("lock", "acquire", "release", "locked?")
                     .build()
         ) {
             @Override
@@ -282,7 +282,7 @@ public VncVal apply(final VncList args) {
                         "  (acquire l)           \n" +
                         "  ;; do something       \n" +
                         "  (release l))          ")
-                    .seeAlso("lock", "acquire")
+                    .seeAlso("lock", "acquire", "try-acquire", "locked?")
                     .build()
         ) {
             @Override
@@ -304,11 +304,12 @@ public VncVal apply(final VncList args) {
                     .meta()
                     .arglists("(locked? lock)")
                     .doc(
-                        "Returns `true` if the lock is free else `false`.")
+                        "Returns `true` if the lock is in use else `false`.")
                     .examples(
                         "(let [l (lock)]         \n" +
+                        "  (acquire l)           \n" +
                         "  (locked? l))          ")
-                    .seeAlso("lock", "acquire")
+                    .seeAlso("lock", "acquire", "try-acquire", "release")
                     .build()
         ) {
             @Override