summaryrefslogtreecommitdiff
path: root/docs/howto/custom-model-fields.txt
AgeCommit message (Collapse)Author
2025-08-25Refs #36485 -- Rewrapped docs to 79 columns line length.David Smith
Lines in the docs files were manually adjusted to conform to the 79 columns limit per line (plus newline), improving readability and consistency across the content.
2025-08-25Refs #36485 -- Removed double spaces after periods in sentences.Natalia
2025-04-15Fixed #36311 -- Unified spelling of "hardcode" and its variants in docs.Ahmed Nassar
Co-authored-by: Natalia <124304+nessita@users.noreply.github.com>
2024-09-19Fixed #35748 -- Documented that fields are excluded from a ModelForm when ↵Clifford Gama
formfield() returns None. Co-authored-by: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com>
2024-01-26Applied Black's 2024 stable style.Mariusz Felisiak
https://github.com/psf/black/releases/tag/24.1.0
2023-11-15Removed obsolete sentence in custom model field docs.Giannis Terzopoulos
2023-03-01Fixed #34140 -- Reformatted code blocks in docs with blacken-docs.django-bot
2023-01-17Removed versionadded/changed annotations for 4.1.Mariusz Felisiak
2022-08-09Fixed #33842 -- Used :source: role for links to repo files on GitHub.Ramil Yanbulatov
2022-04-28Removed hyphen from pre-/re- prefixes.David
"prepopulate", "preload", and "preprocessing" are already in the spelling_wordlist. This also removes hyphen from double "e" combinations with "pre" and "re", e.g. preexisting, preempt, reestablish, or reenter. See also: - https://ahdictionary.com/word/search.html?q=rerun - https://ahdictionary.com/word/search.html?q=recreate - https://ahdictionary.com/word/search.html?q=predetermined - https://ahdictionary.com/word/search.html?q=reuse - https://ahdictionary.com/word/search.html?q=reopening
2022-04-06Fixed #33471 -- Made AlterField operation a noop when changing "choices".sarahboyce
This also allows customizing attributes of fields that don't affect a column definition.
2022-03-10Changed some words to use inline markup.David Smith
2021-08-24Used backend vendors in custom model fields docs.Mariusz Felisiak
2021-07-13Refs #32880 -- Made some titles consistent in how-to documents.Daniele Procida
This retitles documents for consistency, since some already (correctly) begin "How to...".
2020-07-10Corrected custom model fields how-to.Ramiro Morales
get_prep_value() method is complementary of from_db_value(). Follow up to e9103402c0fa873aea58a6a11dba510cd308cb84.
2020-05-04Refs #30573 -- Rephrased "Of Course" and "Obvious(ly)" in documentation and ↵Adam Johnson
comments.
2019-09-06Fixed #30573 -- Rephrased documentation to avoid words that minimise the ↵Tobias Kunze
involved difficulty. This patch does not remove all occurrences of the words in question. Rather, I went through all of the occurrences of the words listed below, and judged if they a) suggested the reader had some kind of knowledge/experience, and b) if they added anything of value (including tone of voice, etc). I left most of the words alone. I looked at the following words: - simply/simple - easy/easier/easiest - obvious - just - merely - straightforward - ridiculous Thanks to Carlton Gibson for guidance on how to approach this issue, and to Tim Bell for providing the idea. But the enormous lion's share of thanks go to Adam Johnson for his patient and helpful review.
2019-03-29Removed unnecessary /static from links to PostgreSQL docs.Nick Pope
2019-03-12Clarified deconstruct() in Custom Model Field docs.David Beitey
2019-02-08Removed extra characters in docs header underlines.Mariusz Felisiak
2018-11-15Used auto-numbered lists in documentation.François Freitag
2018-05-25Fixed #29423 -- Documented Field.value_from_object().Srinivas Reddy Thatiparthy
2017-07-20Fixed #28370 -- Deprecated the context arg of Field.from_db_value() and ↵Tim Graham
Expression.convert_value(). Unused since a0d166306fbdc41f49e6fadf4ec84b17eb147daa.
2017-06-26Refs #23919 -- Stopped inheriting from object to define new style classes.Mariusz Felisiak
Tests and docs complement to cecc079168e8669138728d31611ff3a1e7eb3a9f.
2017-04-27Refs #27795 -- Replaced many force_text() with str()Claude Paroz
Thanks Tim Graham for the review.
2017-02-07Converted usage of ugettext* functions to their gettext* aliasesClaude Paroz
Thanks Tim Graham for the review.
2017-01-25Refs #23919 -- Replaced super(ClassName, self) with super() in docs.chillaranand
2017-01-18Refs #23919 -- Removed Python 2 notes in docs.Tim Graham
2017-01-17Removed versionadded/changed annotations for 1.10.Tim Graham
2016-10-25Updated postgresql.org links to https and made them canonical.Marti Raudsepp
2016-06-08Fixed #26702 -- Documented how to change the base class of a custom field.Baylee Feore
2016-05-04Fixed #22936 -- Obsoleted Field.get_prep_lookup()/get_db_prep_lookup()Claude Paroz
Thanks Tim Graham for completing the initial patch.
2016-02-17Followed recommended ValidationError use in docs.Jon Dufresne
2016-01-11Added missing period to "etc.".pp
2015-12-04Fixed #13774 -- Added models.Field.rel_db_type().Alexander Sosnovskiy
2015-09-23Removed SubfieldBase per deprecation timeline.Tim Graham
2015-08-10Removed unnecessary comma in docsClaude Paroz
2015-08-08Updated Wikipedia links to use httpsClaude Paroz
2015-07-14Fixed #24716 -- Deprecated Field._get_val_from_obj()Thomas Stephenson
The method duplicates the functionality of Field.value_from_object() and has the additional downside of being a privately named public API method.
2015-04-08Fixed #24602 -- Removed obsolete reference to __metaclass__ in custom model ↵Tim Graham
fields docs. Thanks schinckel for the report.
2015-03-17Updated location of database backend data_types attribute in docs.Tim Graham
2015-02-20Update converters to take a consistent set of parameters.Marc Tamlyn
As suggested by Anssi. This has the slightly strange side effect of passing the expression to Expression.convert_value has the expression passed back to it, but it allows more complex patterns of expressions.
2015-02-01Removed versionadded/changed notes for 1.7.Tim Graham
2015-01-08Fixed #24020 -- Refactored SQL compiler to use expressionsAnssi Kääriäinen
Refactored compiler SELECT, GROUP BY and ORDER BY generation. While there, also refactored select_related() implementation (get_cached_row() and get_klass_info() are now gone!). Made get_db_converters() method work on expressions instead of internal_type. This allows the backend converters to target specific expressions if need be. Added query.context, this can be used to set per-query state. Also changed the signature of database converters. They now accept context as an argument.
2015-01-06Fixed #12663 -- Formalized the Model._meta API for retrieving fields.Daniel Pyrathon
Thanks to Russell Keith-Magee for mentoring this Google Summer of Code 2014 project and everyone else who helped with the patch!
2014-09-03Fixed #18757, #14462, #21565 -- Reworked database-python type conversionsMarc Tamlyn
Complete rework of translating data values from database Deprecation of SubfieldBase, removal of resolve_columns and convert_values in favour of a more general converter based approach and public API Field.from_db_value(). Now works seamlessly with aggregation, .values() and raw queries. Thanks to akaariai in particular for extensive advice and inspiration, also to shaib, manfre and timograham for their reviews.
2014-08-18Fixed #14638 -- Clarified model Field.to_python() docs.Tim Graham
Thanks Anubhav Joshi for the patch.
2014-08-15Fixed typo in docs/howto/custom-model-fields.txt.Tim Graham
2014-07-10Fixed #22809 -- Added model Field API reference.Jorge C. Leitão
Thanks to @timgraham for the review.
2014-07-08Fixed #22812 -- Refactored lookup API documentation.Jorge C. Leitão
Thanks Anssi and Tim for reviews.