Move help_text definitions from model forms to models #7427

New Issue

adam · 2025-12-29T20:23:23+01:00

adam commented

2025-12-29 20:23:23 +01:00

Originally created by @jeremystretch on GitHub (Dec 27, 2022).

Originally assigned to: @jeremystretch on GitHub.

Proposed Changes

Move all help_text definitions on model forms to their relevant models, where applicable. For instance, consider ProviderForm:

class ProviderForm(NetBoxModelForm):
    class Meta:
        help_texts = {
            'name': _("Full name of the provider"),
        }

The help text for the name field should be moved to the Provider model:

class Provider(PrimaryModel):
    name = models.CharField(
        max_length=100,
        unique=True,
        help_text=_("Full name of the provider")
    )

Justification

Model forms will automatically infer help text from their associated models. Defining the help text on the model keeps it closer to the field itself and allows it to be referenced for other uses (e.g. API serializers).

Originally created by @jeremystretch on GitHub (Dec 27, 2022). Originally assigned to: @jeremystretch on GitHub. ### Proposed Changes Move all `help_text` definitions on model forms to their relevant models, where applicable. For instance, consider `ProviderForm`: ```python class ProviderForm(NetBoxModelForm): class Meta: help_texts = { 'name': _("Full name of the provider"), } ``` The help text for the `name` field should be moved to the `Provider` model: ```python class Provider(PrimaryModel): name = models.CharField( max_length=100, unique=True, help_text=_("Full name of the provider") ) ``` ### Justification Model forms will automatically infer help text from their associated models. Defining the help text on the model keeps it closer to the field itself and allows it to be referenced for other uses (e.g. API serializers).

adam added the status: accepted type: housekeeping labels 2025-12-29 20:23:23 +01:00

adam closed this issue

2025-12-29 20:23:23 +01:00

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#7427

Move help_text definitions from model forms to models #7427

Proposed Changes

Justification

Move `help_text` definitions from model forms to models #7427