From: Eduardo San Martin Morote <posva13@gmail.com>
Date: Tue, 26 May 2020 15:19:51 +0000 (+0200)
Subject: docs(scrollBehavior): update selector doc
X-Git-Tag: v4.0.0-alpha.13~10
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=323f20b1b10b824f64395eb2f7e0ed855ca30c00;p=thirdparty%2Fvuejs%2Frouter.git

docs(scrollBehavior): update selector doc

[skip ci]
---

diff --git a/src/scrollBehavior.ts b/src/scrollBehavior.ts
index 606b7b94..92eb7df2 100644
--- a/src/scrollBehavior.ts
+++ b/src/scrollBehavior.ts
@@ -32,16 +32,15 @@ export type _ScrollPositionNormalized = {
 
 export interface ScrollPositionElement {
   /**
-   * A valid CSS selector.
-   *
+   * A valid CSS selector. Note some characters must be escaped in id selectors (https://mathiasbynens.be/notes/css-escapes).
    * @example
    * Here are a few examples:
    *
    * - `.title`
    * - `.content:first-child`
    * - `#marker`
-   * - `#marker~with~symbols`
-   * - `#marker.with.dot`: selects `id="marker.with.dot"`, not `class="with dot" id="marker"`
+   * - `#marker\~with\~symbols`
+   * - `#marker.with.dot`: selects `class="with dot" id="marker"`, not `id="marker.with.dot"`
    *
    */
   selector: string