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 HTML/Markdown: don't print header/footer when there are no docs #687

Merged
merged 1 commit into from
Nov 18, 2024

Conversation

jrfnl
Copy link
Member

@jrfnl jrfnl commented Nov 15, 2024

Description

As things were, the Markdown/HTML header and footer would always be printed, even if there were no docs to display.

In my opinion, there should be no output if there are no docs. This is in line with the Text output, which would already not generate any output when there are no docs.

Includes updated test expectations.

Suggested changelog entry

  • Changed: Markdown/HTML Generators will no longer display header/footer output when there are no docs to display

Related issues/external references

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

Also see: #671.

Types of changes

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

… docs

As things were, the Markdown/HTML header and footer would always be printed, even if there were no docs to display.

In my opinion, there should be no output if there are no docs. This is in line with the `Text` output, which would already not generate any output when there are no docs.

Includes updated test expectations.
@jrfnl jrfnl added this to the 3.11.x Next milestone Nov 15, 2024
@jrfnl jrfnl merged commit 6792fb1 into master Nov 18, 2024
72 checks passed
@jrfnl jrfnl deleted the feature/generators-html-markdown-no-output-on-no-docs branch November 18, 2024 17: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