Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generators/Markdown: add blank line after title #722

Merged
merged 1 commit into from
Nov 27, 2024

Conversation

jrfnl
Copy link
Member

@jrfnl jrfnl commented Nov 23, 2024

Description

As per the guidelines for cross-flavour markdown, it is best to always have a blank line below a header.

Ref:

Suggested changelog entry

  • Generators/Markdown: improved compatibility with the variety of available markdown parsers

Related issues/external references

This PR is part of a series of PRs which will add a complete set of tests (and improvements) for the Generator feature.

Also see: #671 and #716.

As per the guidelines for cross-flavour markdown, it is best to always have a blank line below a header.

Ref:
* https://www.markdownguide.org/basic-syntax/#heading-best-practices
@jrfnl jrfnl added this to the 3.11.2 milestone Nov 23, 2024
@jrfnl jrfnl merged commit 205425b into master Nov 27, 2024
72 checks passed
@jrfnl jrfnl deleted the feature/generators-markdown-blank-line-after-title branch November 27, 2024 08:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant