Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed #20744 -- Removed generic kwargs from form Field class docs. #18092

Merged
merged 1 commit into from Apr 26, 2024

Conversation

adamzap
Copy link
Contributor

@adamzap adamzap commented Apr 20, 2024

Trac ticket number

ticket-20744

Branch description

I changed .. class:: Field(**kwargs) to .. class:: Field in the form Field docs because the ticket says having **kwargs there implies that any keyword arguments can be passed to the class, which is not true.

image

This seems to be how similar classes like Form are documented, so I thought this simple fix would be sufficient.

Checklist

  • This PR targets the main branch.
  • The commit message is written in past tense, mentions the ticket number, and ends with a period.
  • I have checked the "Has patch" ticket flag in the Trac system.
  • I have added or updated relevant tests.
  • I have added or updated relevant docs, including release notes if applicable.
  • For UI changes, I have attached screenshots in both light and dark modes.

Copy link
Contributor

@nessita nessita left a comment

Choose a reason for hiding this comment

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

Thank you @adamzap for this work! I agree this is an acceptable solution and that is consistent with how the Form class is documented.

@nessita nessita merged commit 828b94b into django:main Apr 26, 2024
28 checks passed
@adamzap adamzap deleted the ticket_20744 branch April 26, 2024 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants