Skip to content

Backslash \ is not standard markdown syntax for paragraph #194

@hdamker

Description

@hdamker

Problem description

While backslash \ is supported in GitHub for hard line breaks it might be not supported in all tools. For paragraph separation double line breaks are more portable.

Also URLs in the links are split with \ which should be kept on one line. The backslash approach might cause issues where:

  • Some parsers show the literal \ character
  • URLs might break if the parser doesn't handle the line continuation
  • The formatting might not be consistent across different tools

Expected action

For paragraph separation just use double line breaks.

  • It's the most portable and widely supported
  • It creates clean paragraph separation
  • It renders consistently across different OpenAPI viewers (Swagger UI, ReDoc, etc.)
  • It's the simplest and most readable in the source

Keep URLs on one line

Additional context

Metadata

Metadata

Assignees

No one assigned

    Labels

    FixeddocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions