matrix-org / matrix-org/matrix.org
matrix.org: Explained 'timeout' Parameter Is Missing in the Code Example.
- Dominant language
- JavaScript
- Stars
- 616
- Forks
- 463
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 19
Description
I hope I'm correct here about reporting errors in the intro docs on the main matrix.org website, if not then I'm sorry in advance.
**Link to problem area**:
https://www.matrix.org/docs/guides/client-server-api#getting-live-state
**Issue**
_What is wrong?_
The section "Getting live state" under the above link mentions a `timeout` parameter one should apply. But the following code snippet that is supposed to demonstrate the use of that `timeout` parameter doesn't actually have the parameter in the used URL for the cURL command.
**Expected behaviour**
_How can the issue be fixed? Links to implementations/documents which prove the spec is wrong are appreciated._
Add the missing timeout=somevalue argument to the URL in the code snippet.
Contributor guide
Research direction
Open the linked matrix.org Client-Server API guide and find the “Getting live state” section and its cURL code snippet. Update the example URL to include a timeout=somevalue argument, then verify that the snippet matches the surrounding explanation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100