Coding style docs should contain incorrect example for Model style.

[JiriKr]

​https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/#model-style

In dev documentation version there is no difference between Do this: and Don’t do this: in Meta section.

class Person(models.Model):
    first_name = models.CharField(max_length=20)
    last_name = models.CharField(max_length=40)

    class Meta:
        verbose_name_plural = "people"

In 4.1 version it is correct. Related to https://code.djangoproject.com/ticket/34140 .

[Mariusz Felisiak]

Great catch! We should remove this blank line:

docs/internals/contributing/writing-code/coding-style.txt

@@ -282 +282 @@
       class Person(models.Model):
           first_name = models.CharField(max_length=20)
           last_name = models.CharField(max_length=40)
-
           class Meta:
               verbose_name_plural = "people"
 

I hope there is a way to skip blacken-docs on this example.

JiriKr, Would you like to prepare a patch?

[Mariusz Felisiak]

TBH, I think this example is no longer needed as we have black CI builds. I'd remove it:

docs/internals/contributing/writing-code/coding-style.txt

@@ -279 +279 @@
 
   Don't do this::
 
-      class Person(models.Model):
-          first_name = models.CharField(max_length=20)
-          last_name = models.CharField(max_length=40)
-
-          class Meta:
-              verbose_name_plural = "people"
-
-  Don't do this, either::
-
       class Person(models.Model):
           class Meta:
               verbose_name_plural = "people"

[Paolo Melchiorre]

I agree with Mariusz

[JiriKr]

Replying to Mariusz Felisiak:

JiriKr, Would you like to prepare a patch?

Yes, I would like to. It's my first contribution to Django (hope it will be correct).

Thank you for guidance, I prepared ​PR

[JiriKr]

Sorry, not sure if I can change Triage Stage.

[Mariusz Felisiak]

Sorry, not sure if I can change Triage Stage.

You shouldn't change stage for your own tickets/PRs ;), but I can. Thanks!

[Mariusz Felisiak <felisiak.mariusz@…>]

In cfe563ff:

Fixed #34446 -- Removed unneeded and incorrect example in coding style docs.

[Mariusz Felisiak <felisiak.mariusz@…>]

In 634acb5:

[4.2.x] Fixed #34446 -- Removed unneeded and incorrect example in coding style docs.

Backport of cfe563ffaf01d22343717176d96bfca0d05f60fb from main