docs: note about children in matched

Close #1031

diff --git a/docs/api/index.md b/docs/api/index.md
index aa18eb96b9b02a9f1e628e8b6f76ee9b128e8f6d..1273d6c0caa50a4e1cf36cf9ab198b343b9ef82d 100644 (file)
--- a/docs/api/index.md
+++ b/docs/api/index.md
@@ -896,7 +896,7 @@ Normalized version of a [Route Record](#routerecordraw)
 - **Type**: Array of normalized [route records](#routerecordnormalized)
 - **Details**:
 
-  Children route records of the current route. Empty array if none.
+  Children route records of a route at the time it was added. Empty array if none. Note this array doesn't update when `addRoute()` and `removeRoute()` are called.
 
 ### components