Add meta description to docs

This commit is contained in:
Stephan Hoyer 2018-11-27 23:50:45 +01:00
parent c7b56161a5
commit 7b1fda5b66
47 changed files with 540 additions and 267 deletions

View file

@ -1,3 +1,6 @@
<!--meta-description
Documentation on m.parsePathname(), which parses URLs to path and query object
-->
# parsePathname(string)
- [Description](#description)
@ -23,7 +26,7 @@ var object = m.parsePathname("/path/user?a=1&b=2")
Argument | Type | Required | Description
------------ | -------- | -------- | ---
`string` | `String` | Yes | A URL
`url` | `String` | Yes | A URL
**returns** | `Object` | | A `{path, params}` pair where `path` is the [normalized path](paths.md#path-normalization) and `params` is the [parsed parameters](paths.md#parameter-normalization).
[How to read signatures](signatures.md)