Markdown unknown tags#79
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new RDoc option to control how reverse_markdown handles unknown HTML tags when generating Markdown, with corresponding CLI/config documentation and tests to validate behavior and error handling.
Changes:
- Introduces
markdown_unknown_tagsas anRDoc::Optionssetting (plus CLI flag--markdown-unknown-tags) and validates accepted modes. - Passes the configured
unknown_tagsmode through toReverseMarkdown.convertduring markdown generation. - Adds coverage for default behavior, each supported mode, CLI parsing,
.rdoc_optionshash loading, and YAML serialization cases; documents usage in the README and changelog.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| test/test_markdown_helpers.rb | Adds tests and helper utilities to cover the new markdown_unknown_tags option across default/CLI/YAML behaviors. |
| README.md | Documents the new option, accepted values, and .rdoc_options configuration. |
| lib/rdoc/generator/markdown.rb | Implements the option plumbing (RDoc::Options extension, CLI registration, validation) and wires unknown_tags: into ReverseMarkdown.convert. |
| CHANGELOG.md | Records the addition of the new markdown_unknown_tags option. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I want to be able to control how html to markdown conversion works with this gem. This PR introduces a configurable attribute that will be passed to ReverseMarkdown gem