From: Eduardo San Martin Morote <posva13@gmail.com>
Date: Fri, 20 Aug 2021 08:55:44 +0000 (+0200)
Subject: chore: comment
X-Git-Tag: v4.0.12~27
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e42e93d405fcd12eaf814fe433ac3b49432de0b8;p=thirdparty%2Fvuejs%2Frouter.git

chore: comment
---

diff --git a/src/query.ts b/src/query.ts
index 1074c8c7..21142e1c 100644
--- a/src/query.ts
+++ b/src/query.ts
@@ -2,8 +2,14 @@ import { decode, encodeQueryKey, encodeQueryValue, PLUS_RE } from './encoding'
 
 /**
  * Possible values in normalized {@link LocationQuery}. `null` renders the query
- * param but without an `=`: `?isNull&isEmpty=&other=other` -> `{ isNull: null,
- * isEmpty: '', other: 'other' }`.
+ * param but without an `=`.
+ *
+ * @example
+ * ```
+ * ?isNull&isEmpty=&other=other
+ * gives
+ * `{ isNull: null, isEmpty: '', other: 'other' }`.
+ * ```
  *
  * @internal
  */