urbit-ob

commit 7df69f05b43e90ee689d5ed6001f5ce2f1a0fade
parent 611c796932f14244a46129f7ca14ee27cd625019
Author: matildepark <matilde.park@urbit.org>
Date:   Fri, 22 Apr 2022 10:23:18 -0700

co.js: fix isValidPat return documentation

These return booleans, not strings, just tweaking that.
Diffstat:
M
src/internal/co.js
 | 
6
+++---

1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/internal/co.js b/src/internal/co.js
@@ -328,7 +328,7 @@ const sein = name => {
  * will not.
  *
  * @param  {String}  name a @p or @q value
- * @return  {String}
+ * @return  {boolean}
  */
 const isValidPat = name => {
   if (typeof name !== 'string') {
@@ -357,7 +357,7 @@ const isValidPat = name => {
  * Validate a @p string.
  *
  * @param  {String}  str a string
- * @return  {String}
+ * @return  {boolean}
  */
 const isValidPatp = str =>
   isValidPat(str) && str === patp(patp2dec(str))
@@ -366,7 +366,7 @@ const isValidPatp = str =>
  * Validate a @q string.
  *
  * @param  {String}  str a string
- * @return  {String}
+ * @return  {boolean}
  */
 const isValidPatq = str =>
   isValidPat(str) && eqPatq(str, patq(patq2dec(str)))