starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-02-26 02:35:12 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

[PR #4327] [CLOSED] 4078: Standardize 'comments' and 'description' Fields #12818

New Issue
Closed
opened 2025-12-29 22:23:47 +01:00 by adam · 0 comments
adam commented 2025-12-29 22:23:47 +01:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/4327
Author: @dstarner
Created: 3/7/2020
Status: ❌ Closed

Base: develop-2.8 ← Head: 4078-standardize-description-comments

📄 Description

Fixes: #4078

NOTE: This is merging into the develop-2.8 branch, because this is a 2.8 milestone issue.

Implements a DescriptionModel and CommentModel that standardizes the comments and description fields for any/all models. They are broken out into model extensions / mixins to make it easier to standardize across the application(s) for current and future models.

The migration files were added as <id>_standarize_description_comment_fields.py which I felt was an appropriate name for them.

I initially called them ...Mixins but when being appended to some of the more basic models, this caused a method resolution order exception so I called them Models because MyModel(models.Model, CommentModel) had to become MyModel(CommentModel).

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/netbox-community/netbox/pull/4327 **Author:** [@dstarner](https://github.com/dstarner) **Created:** 3/7/2020 **Status:** ❌ Closed **Base:** `develop-2.8` ← **Head:** `4078-standardize-description-comments` --- ### 📄 Description <!-- Thank you for your interest in contributing to NetBox! Please note that our contribution policy requires that a feature request or bug report be opened for approval prior to filing a pull request. This helps avoid wasting time and effort on something that we might not be able to accept. Please indicate the relevant feature request or bug report below. IF YOUR PULL REQUEST DOES NOT REFERENCE AN ACCEPTED BUG REPORT OR FEATURE REQUEST, IT WILL BE MARKED AS INVALID AND CLOSED. --> ### Fixes: #4078 <!-- Please include a summary of the proposed changes below. --> **NOTE**: This is merging into the `develop-2.8` branch, because this is a 2.8 milestone issue. Implements a `DescriptionModel` and `CommentModel` that standardizes the `comments` and `description` fields for any/all models. They are broken out into model extensions / mixins to make it easier to standardize across the application(s) for current *and* future models. The migration files were added as `<id>_standarize_description_comment_fields.py` which I felt was an appropriate name for them. --- I initially called them `...Mixins` but when being appended to some of the more basic models, this caused a [method resolution order exception](https://stackoverflow.com/questions/3003053/metaclass-multiple-inheritance-inconsistency) so I called them `Model`s because `MyModel(models.Model, CommentModel)` had to become `MyModel(CommentModel)`. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-29 22:23:47 +01:00
adam closed this issue 2025-12-29 22:23:48 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#12818
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?