Skip to content

Add missing article in "writable relationship field" in documentation - #10052

Merged
browniebroke merged 2 commits into
encode:mainfrom
haimingZZ:fix/relations-writable-article
Sep 23, 2026
Merged

browniebroke merged 2 commits into
encode:mainfrom
haimingZZ:fix/relations-writable-article

Conversation

@haimingZZ

Copy link
Copy Markdown
Contributor

Summary

Small docs grammar fix in docs/api-guide/relations.md.

The sentence:

The queryset argument is only ever required for writable relationship field, in which case it is used for performing the model instance lookup, that maps from the primitive user input, into a model instance.

drops the article before writable. The fix restores it to for *a writable* relationship field.

Verification

Compare with the very next paragraph in the same section, which spells out the same idea correctly with the plural form:

This behavior is now replaced with always using an explicit queryset argument for writable relational fields.

The singular form on line 462 is the only one missing the article. No code change, no behaviour change; docs-only 1-character diff.

Why this is a good first PR

  • Pure docs change, 1 insertion / 1 deletion
  • No tests to update, no migration
  • Same shape of fix as recent merged grammar nits on these docs (e.g. PRs around allows to create/update in serializers.md and allows to choose in pagination.md)

… sentence

The sentence read 'required for *writable* relationship field' which
drops the article, breaking the grammar. Compare with the same idea
spelled out correctly four lines below: 'writable relational fields'.

This is the same class of doc-grammar fix that has landed in similar
nits on the same docs (e.g. the recent 'Fix allows to X' PRs).
@p-r-a-v-i-n

p-r-a-v-i-n commented Sep 21, 2026 •

Copy link
Copy Markdown
Contributor

For learning purpose, I wanted to know how two github users are responsible for this PR ?

Comment thread docs/api-guide/relations.md Outdated
@browniebroke browniebroke changed the title docs(relations): add missing article in "writable relationship field" sentence Add missing article in "writable relationship field" in documentation Sep 23, 2026
@browniebroke
browniebroke merged commit 0038f75 into encode:main Sep 23, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

4 participants