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: fix footer not parsing #698

Merged
merged 1 commit into from
Nov 22, 2024

Conversation

jrfnl
Copy link
Member

@jrfnl jrfnl commented Nov 18, 2024

Description

As things were, if the output of the Markdown doc generation would be used in a Markdown-friendly environment, the footer would not be interpreted as markdown and would not display correctly.

Fixed now by adding a blank line at the start of the footer.

Includes updated test expectations.

Before

1-fix-footer-not-parsing-before

After

1-fix-footer-not-parsing-after

Suggested changelog entry

  • Markdown Generator : link in the documentation footer would not display correctly.

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.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)

As things were, if the output of the Markdown doc generation would be used in a Markdown-friendly environment, the footer would not be interpreted as markdown and would not display correctly.

Fixed now by adding a blank line at the start of the footer.

Includes updated test expectations.
@jrfnl jrfnl added this to the 3.11.x Next milestone Nov 18, 2024
@jrfnl jrfnl merged commit e3400e3 into master Nov 22, 2024
72 checks passed
@jrfnl jrfnl deleted the feature/generators-markdown-fix-footer-parsing branch November 22, 2024 16:09
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