Comments formatting is display as one long line of text #3742

Closed
opened 2025-12-29 18:30:52 +01:00 by adam · 4 comments
Owner

Originally created by @chrisintheshell on GitHub (Jun 2, 2020).

Environment

  • Python version: 3.6.8
  • NetBox version: 2.8.5

Steps to Reproduce

  1. Create or edit circuit and in the comments section create text followed by a new lines (several separate lines of text
  2. Click on create or update for that circuit
  3. Now when viewing the circuit, the comments show as one long line, instead of separate lines.

Expected Behavior

I expect to see multiple lines of text in the comments section

Observed Behavior

Instead I'm seeing a long line of text. I'm also seeing this in other sections (e.g. Circuit Provider - NOC Contact). I think it affects section that allows you to have multiple lines of text.
nb_editing
nb_display_issue

Originally created by @chrisintheshell on GitHub (Jun 2, 2020). <!-- NOTE: IF YOUR ISSUE DOES NOT FOLLOW THIS TEMPLATE, IT WILL BE CLOSED. This form is only for reproducible bugs. If you need assistance with NetBox installation, or if you have a general question, DO NOT open an issue. Instead, post to our mailing list: https://groups.google.com/forum/#!forum/netbox-discuss Please describe the environment in which you are running NetBox. Be sure that you are running an unmodified instance of the latest stable release before submitting a bug report, and that any plugins have been disabled. --> ### Environment * Python version: 3.6.8 * NetBox version: 2.8.5 <!-- Describe in detail the exact steps that someone else can take to reproduce this bug using the current stable release of NetBox. Begin with the creation of any necessary database objects and call out every operation being performed explicitly. If reporting a bug in the REST API, be sure to reconstruct the raw HTTP request(s) being made: Don't rely on a client library such as pynetbox. --> ### Steps to Reproduce 1. Create or edit circuit and in the comments section create text followed by a new lines (several separate lines of text 2. Click on create or update for that circuit 3. Now when viewing the circuit, the comments show as one long line, instead of separate lines. <!-- What did you expect to happen? --> ### Expected Behavior I expect to see multiple lines of text in the comments section <!-- What happened instead? --> ### Observed Behavior Instead I'm seeing a long line of text. I'm also seeing this in other sections (e.g. Circuit Provider - NOC Contact). I think it affects section that allows you to have multiple lines of text. ![nb_editing](https://user-images.githubusercontent.com/13229225/83538866-2e37e780-a4ab-11ea-992a-3f9d22bc5aa5.png) ![nb_display_issue](https://user-images.githubusercontent.com/13229225/83538868-2ed07e00-a4ab-11ea-9d47-37e36f06f981.png)
adam closed this issue 2025-12-29 18:30:52 +01:00
Author
Owner

@chicks-net commented on GitHub (Jun 2, 2020):

This is how Markdown normally works. Have you tried putting a blank link between them?

@chicks-net commented on GitHub (Jun 2, 2020): This is how Markdown normally works. Have you tried putting a blank link between them?
Author
Owner

@lampwins commented on GitHub (Jun 2, 2020):

This is the expected behavior. The comments field is formatted with markdown.

You need to add an additional blank line:

first line
still the first line

a new line
@lampwins commented on GitHub (Jun 2, 2020): This is the expected behavior. The comments field is formatted with markdown. You need to add an additional blank line: ``` first line still the first line a new line ```
Author
Owner

@chrisintheshell commented on GitHub (Jun 2, 2020):

How about other free form fields (e.g. NOC Contact)? When I add text to the NOC Contact field or any other free form field, it does the same thing with text.

Do all of these fields behave the same way? I seem to remember in past versions that the comments section and other fields used to display the text just as they are entered (with new lines).

@chrisintheshell commented on GitHub (Jun 2, 2020): How about other free form fields (e.g. **NOC Contact**)? When I add text to the NOC Contact field or any other free form field, it does the same thing with text. Do all of these fields behave the same way? I seem to remember in past versions that the comments section and other fields used to display the text just as they are entered (with new lines).
Author
Owner

@jeremystretch commented on GitHub (Jun 2, 2020):

We changed the library used for rendering Markdown some time ago. The current behavior reflects what is defined in the Markdown specification.

All Markdown-enabled fields render in the same manner.

@jeremystretch commented on GitHub (Jun 2, 2020): We changed the library used for rendering Markdown some time ago. The current behavior reflects what is defined in the Markdown specification. All Markdown-enabled fields render in the same manner.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#3742