Skip to content

Fixed #35659 -- Documented db_default behaviour before instances are saved. #18454

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fixed #35659 -- Documented db_default behaviour before instances are saved. #18454

wants to merge 3 commits into from
+28 −0

Conversation

jeromecagado
Copy link

@jeromecagado jeromecagado commented Aug 7, 2024 •
edited
Loading

Trac ticket number

ticket-35659

Branch description

Added documentation to explain the db_default behavior in the BooleanField class, ensuring users understand how default values are handled when Field.default isn't specified.

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.

github-actions[bot]
github-actions bot reviewed Aug 7, 2024
View reviewed 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 ⛵️!

@shangxiao
Copy link
Contributor

Appreciate the efforts but I'm not sure we want to document the behaviour in this manner.

Specifically we need to avoid the provided example of casting to bools which imho is misleading but more generally I think we need to have a discussion about whether we need a bit on DatabaseDefault (whether or not that sits in its own dedicated section or just a paragraph within this section).

Nobody will really need to instantiate anything of type DatabaseDefault but people will be exposed to it like we've seen in the ticket.

@sarahboyce sarahboyce changed the title Document db_default behavior in BooleanField Fixed #35659 -- Documented db_default behaviour before instances are saved. Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jeromecagado @shangxiao @jcagado