graphile / graphile/graphile.github.io
Inconsistent documentation on named types for custom mutations
Nobody has claimed this yet.
- Dominant language
- SCSS
- Stars
- 27
- Forks
- 126
- PR merge metrics
- No merged PRs in 30d
Description
It's amazing that postgraphile can now handle all sorts of functions. The documentation is updated at https://www.graphile.org/postgraphile/function-restrictions/, but not at https://www.graphile.org/postgraphile/custom-mutations/. You should probably update the latter as well to avoid any confusion :)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the guidance at https://www.graphile.org/postgraphile/function-restrictions/ and compare it with https://www.graphile.org/postgraphile/custom-mutations/. Update the custom mutations documentation so its named-type guidance is consistent with the function restrictions page, then verify the published page is no longer confusing.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100