use help_text to document model columns

Docs > Code Analysis > Static Analysis Rules > use help_text to document model columns

This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

Metadata

ID: python-django/model-help-text

Language: Python

Severity: Notice

Category: Best Practices

Description

Use help_text to document the fields used in your database.

Learn More

Django Documentation: help_text

Non-Compliant Code Examples

class MyModel(models.Model):
  my_field = models.DateField()
  last_name = models.CharField(max_length=40)  # add help_text to explain what this field is doing

Compliant Code Examples

class MyModel(models.Model):
  my_field = models.DateField(help_text = "Use format YYYY/MM/DD")

How to use this rule

1
2
rulesets:
  - python-django     # Rules to enforce Python django.

Create a static-analysis.datadog.yml with the content above at the root of your repository
Use our free IDE Plugins or add Code Analysis scans to your CI pipelines
Get feedback on your code

For more information, please read the Code Analysis documentation

VS Code Extension

Identify code vulnerabilities directly in your
VS Code editor

JetBrains Plugin

Identify code vulnerabilities directly in
JetBrains products