facebook / facebook/relay

[Modern] errors in documentation examples

Open
#2,135 4 comments 1 reaction 0 assignees View on GitHub
docs
Dominant language
Rust
Stars
19k
Forks
1.9k
PR merge metrics
No merged PRs in 30d

Description

in [/docs/pagination-container.html](https://facebook.github.io/relay/docs/pagination-container.html)

the example fails:
* ```@arguments``` is missing in the pagination query definition
* ```@argummentDefinitions``` is missing in the ```Feed_user``` fragment

in [/docs/mutations.html](https://facebook.github.io/relay/docs/mutations.html)
* ```deletedIDFieldName``` and ```connectionKeys.key``` should be quoted
* ```rangeBehavior ``` should not appear in ```RANGE_DELETE``` example since it is not used
* ```deletedIDFieldName```: the name of this parameter leads to confusion since
```deletedIDFieldName: 'removedId'```
is not similar to
```deletedIDFieldName: ['removedId']```
The documentation should draw our attention on this.
* ```connectionKeys```: The documentation does not state the updater will stop on the first connection found.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.