Skip to content

Commit 479b602

Browse files
taiontimdorr
authored andcommitted
Add missing deprecated marker for <Router> props (#3576)
1 parent e01264d commit 479b602

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/API.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,11 @@ function createElement(Component, props) {
7777
}
7878
```
7979

80-
##### `stringifyQuery(queryObject)`
80+
##### `stringifyQuery(queryObject)` (deprecated)
8181
A function used to convert an object from [`<Link>`](#link)s or calls to
8282
[`transitionTo`](#transitiontopathname-query-state) to a URL query string.
8383

84-
##### `parseQueryString(queryString)`
84+
##### `parseQueryString(queryString)` (deprecated)
8585
A function used to convert a query string into an object that gets passed to route component props.
8686

8787
##### `onError(error)`
@@ -117,15 +117,15 @@ A [location descriptor](https://github.com/mjackson/history/blob/master/docs/Glo
117117
* `hash`: A hash to put in the URL, e.g. `#a-hash`.
118118
* `state`: State to persist to the `location`.
119119

120-
##### `query` **([Deprecated](/upgrade-guides/v2.0.0.md#link-to-onenter-and-isactive-use-location-descriptors) see `to`)**
120+
##### `query` **([deprecated](/upgrade-guides/v2.0.0.md#link-to-onenter-and-isactive-use-location-descriptors) see `to`)**
121121
An object of key:value pairs to be stringified.
122122

123-
##### `hash` **([Deprecated](/upgrade-guides/v2.0.0.md#link-to-onenter-and-isactive-use-location-descriptors) see `to`)**
123+
##### `hash` **([deprecated](/upgrade-guides/v2.0.0.md#link-to-onenter-and-isactive-use-location-descriptors) see `to`)**
124124
A hash to put in the URL, e.g. `#a-hash`.
125125

126126
_Note: React Router currently does not manage scroll position, and will not scroll to the element corresponding to the hash._
127127

128-
##### `state` **([Deprecated](/upgrade-guides/v2.0.0.md#link-to-onenter-and-isactive-use-location-descriptors) see `to`)**
128+
##### `state` **([deprecated](/upgrade-guides/v2.0.0.md#link-to-onenter-and-isactive-use-location-descriptors) see `to`)**
129129
State to persist to the `location`.
130130

131131
##### `activeClassName`

0 commit comments

Comments
 (0)