Skip to content

docs: Fix trailing many '+' and delimit note blocks.#4039

Closed
BsAtHome wants to merge 1 commit into
LinuxCNC:masterfrom
BsAtHome:fix_doc-qtdragon
Closed

docs: Fix trailing many '+' and delimit note blocks.#4039
BsAtHome wants to merge 1 commit into
LinuxCNC:masterfrom
BsAtHome:fix_doc-qtdragon

Conversation

@BsAtHome
Copy link
Copy Markdown
Contributor

Remove most trailing '+' to force line breaks. Hard line breaks are mostly inappropriate and it should be left to paragraph formatting.
When using hard breaks in lists, then the line after the break must be indented or a warning will be issued. This was the actual cause of the messages identified in #4038.

The change caused some note/important/caution blocks to be slightly off because they were not delimited and relied on empty line delimit. These are now properly delimited so that blocks are actually identified as blocks.

This fixes #4038.

@c-morley
Copy link
Copy Markdown
Collaborator

I dont want this. I like my docs as they were. If there were warnings on a couple lines I will look at those, but please don't reformat my docs.
Thanks

@BsAtHome
Copy link
Copy Markdown
Contributor Author

Forced line breaks are inappropriate formatting and actually break proper formatting when floating formatting is used (like in a browser).

However, you want it, you do it and I'll refrain from looking at your the docs.

@BsAtHome BsAtHome closed this May 17, 2026
@BsAtHome BsAtHome deleted the fix_doc-qtdragon branch May 17, 2026 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

malformed adoc file for qtdragon

2 participants