MongoEngine / MongoEngine/mongoengine
Documentation for `null` on a field
Open
Nobody has claimed this yet.
Awaiting Response
Documentation
Field-default-value
- Dominant language
- Python
- Stars
- 4.3k
- Forks
- 1.2k
- Avg merge
- 4h 41m
- Merged PRs (30d)
- 11
Description
The docs presently read:
:param null:(optional) Is the field value can be null. If no and there is a default value
then the default value is set
Aside from the obvious grammar errors, I still have no idea what it means, or what it does.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the null parameter documentation in mongoengine/base/fields.py at lines 65-66, then inspect the surrounding field behavior to determine what the option means. Update the wording so its behavior and interaction with default values are clear and grammatically correct.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100