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 #35623 -- Documented that a field cannot be named 'check'. #18465

Merged
merged 1 commit into from
Aug 12, 2024

Conversation

mohammadsaleehi
Copy link

@mohammadsaleehi mohammadsaleehi commented Aug 10, 2024

Trac ticket number

ticket-35623

Branch description

Based on the discussion in #35623, I added a section to the documentation explaining that the word ‍‍‍‍‍‍check is a reserved keyword, and included the suggested solution along with an example.

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.
  • I have attached screenshots in both light and dark modes for any UI changes.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hello! Thank you for your contribution 💪

As it's your first contribution be sure to check out the patch review checklist.

If you're fixing a ticket from Trac make sure to set the "Has patch" flag and include a link to this PR in the ticket!

If you have any design or process questions then you can ask in the Django forum.

Welcome aboard ⛵️!

@mohammadsaleehi mohammadsaleehi force-pushed the main branch 21 times, most recently from 57335a7 to c410583 Compare August 11, 2024 08:46
option. For example::


class Example(models.Model):
Copy link
Member

Choose a reason for hiding this comment

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

This is now a bit redundant with the reference to db_column directly below this. In my opinion it's not needed.

Copy link
Author

Choose a reason for hiding this comment

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

Thank you. I removed the additional explanations.

Copy link
Contributor

@sarahboyce sarahboyce 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 @mohammadsaleehi ⭐ this looks good to me
Welcome on-board ⛵

@sarahboyce sarahboyce changed the title Fixed #35623 -- Update docs: Add restriction on using 'check' as a field name in models. Fixed #35623 -- Documented that a field cannot be named 'check'. Aug 12, 2024
@sarahboyce sarahboyce merged commit ca47884 into django:main Aug 12, 2024
25 of 28 checks passed
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.

3 participants