Spec website out of date
- Dominant language
- Rust
- Stars
- 19k
- Forks
- 1.9k
- PR merge metrics
- No merged PRs in 30d
Description
Spec website has this statement
https://relay.dev/graphql/connections.htm#sel-EALFDCFqBCJvBrsC
>PageInfo must contain fields hasPreviousPage and hasNextPage, both of which return non-null booleans. It must also contain fields startCursor and endCursor, both of which return non-null opaque strings.
but the spec docs in the repo state
https://github.com/facebook/relay/blob/73f01accc7d5ea4cd241f86919d77b29d6c175aa/website/spec/Connections.md?plain=1#L334-L337
I was implementing this spec on a new project and ran into the issue `Cannot return null for non-nullable field PageInfo.endCursor.` when it got me thinking that those cursors should not be non-null in the case of an empty list but the spec said otherwise. I looked into the spec in the repo to request an edit and to my surprise it was already updated
Contributor guide
Research direction
Compare the deployed Connections specification at relay.dev/graphql/connections.htm with website/spec/Connections.md, especially the PageInfo wording around lines 334-337. Start by checking why the deployed page differs from the repository version. Done means the public specification reflects the current repository text, including the cursor nullability statement.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- graphql
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100