From 3754e00ee0c21a89a4c49a64e049f311983b047d Mon Sep 17 00:00:00 2001 From: Arthur Date: Tue, 27 Jun 2023 08:44:54 -0700 Subject: [PATCH] 12809 document not to use underscores in model names --- docs/plugins/development/models.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/plugins/development/models.md b/docs/plugins/development/models.md index b3bcb292a..c51d025f4 100644 --- a/docs/plugins/development/models.md +++ b/docs/plugins/development/models.md @@ -19,6 +19,9 @@ class MyModel(models.Model): Every model includes by default a numeric primary key. This value is generated automatically by the database, and can be referenced as `pk` or `id`. +!!! note + Model names should adhere to [PEP8](https://www.python.org/dev/peps/pep-0008/#class-names) standards and be CapWords (no underscores). Using underscores in model names will result in problems with permissions. + ## Enabling NetBox Features Plugin models can leverage certain NetBox features by inheriting from NetBox's `NetBoxModel` class. This class extends the plugin model to enable features unique to NetBox, including: