correct docs gen#998
Conversation
There was a problem hiding this comment.
Pull request overview
Fixes GraphQL Markdown docs generation so Relay pagination arguments (after, before, first, last) are not rendered for connection-returning fields, decluttering field tables to only show schema-defined custom arguments.
Changes:
- Added
documented_argumentshelper that filters out connection pagination args for connection fields, and refactoredarguments?to use it. - Updated
object.md.erbandinterface.md.erbtemplates to renderdocumented_arguments.call(field)instead of rawfield[:arguments]. - Regenerated
docs/graphql/object/flow.mdanddocs/graphql/object/namespace.mdto remove pagination args fromdailyRuntimeUsages.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tooling/graphql/docs/helper.rb | Introduces documented_arguments and exposes it to templates; rewrites arguments? in terms of it. |
| tooling/graphql/docs/templates/object.md.erb | Uses documented_arguments to render field arg tables. |
| tooling/graphql/docs/templates/interface.md.erb | Same change for interface template. |
| docs/graphql/object/flow.md | Regenerated docs: pagination args removed from dailyRuntimeUsages. |
| docs/graphql/object/namespace.md | Regenerated docs: pagination args removed from dailyRuntimeUsages. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
GitLab Pipeline ActionGeneral informationLink to pipeline: https://gitlab.com/code0-tech/development/sagittarius/-/pipelines/2564935694 Status: Passed Job summariesrspec: [cloud]Coverage report available at https://code0-tech.gitlab.io/-/development/sagittarius/-/jobs/14618945990/artifacts/tmp/coverage/index.html rspec: [ee]Coverage report available at https://code0-tech.gitlab.io/-/development/sagittarius/-/jobs/14618945989/artifacts/tmp/coverage/index.html rspec: [ce]Coverage report available at https://code0-tech.gitlab.io/-/development/sagittarius/-/jobs/14618945988/artifacts/tmp/coverage/index.html docs:previewDocumentation preview available at https://code0-tech.gitlab.io/-/development/telescopium/-/jobs/14618953485/artifacts/out/index.html rubocop855 files inspected, no offenses detected |
No description provided.