Skip to content

support @argNdescription to document arguments in GraphQL - #3168

Open
tsnobip wants to merge 5 commits into
graphile:nextfrom
tsnobip:arg-description
Open

tsnobip wants to merge 5 commits into
graphile:nextfrom
tsnobip:arg-description

Conversation

@tsnobip

@tsnobip tsnobip commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

Fixes #1419

Description

Performance impact

Impact should be low, it just adds support for a new smart tag.

Security impact

Same

Checklist

  • My code matches the project's code style and yarn lint:fix passes.
  • I've added tests for the new feature, and yarn test passes.
  • I have detailed the new feature in the relevant documentation.
  • I have added this feature to 'Pending' in the RELEASE_NOTES.md file (if one exists).
  • If this is a breaking change I've explained why.

@changeset-bot

changeset-bot Bot commented Sep 11, 2026 •

Copy link
Copy Markdown

馃 Changeset detected

Latest commit: 616ebf2

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
@dataplan/pg Minor
graphile-build-pg Minor
postgraphile Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@benjie benjie left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice; thanks for taking this on! Since this is a 'minor', please target branch next (all the PostGraphile 5.2 stuff). The main change is to move description to an explicit PgResourceParameter field rather than an extension.

Comment thread .changeset/describe-function-arguments.md
Comment thread .changeset/describe-function-arguments.md Outdated
Comment thread graphile-build/graphile-build-pg/src/plugins/PgArgumentDescriptionsPlugin.ts Outdated
@tsnobip
tsnobip changed the base branch from main to next October 10, 2026 14:30
@tsnobip
tsnobip requested a review from benjie October 10, 2026 14:30

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Allow documenting function parameters via smart-comments

2 participants