liran-funaro / sphinx-markdown-builder / 43191147567

100%

push

github

Break up --> inside comments so a comment does not end early (#137)

## Summary

A comment is written as `<!-- text -->`, so a `-->` in its text ended
the HTML comment early, and the rest of the comment showed as page text.
HTML5 also ends a comment at `--!>`.

Comments now use a `CommentContext` (a `WrappedContext` for `<!-- ` / `
-->`). Its `make()` breaks up the two sequences that end an HTML
comment: `-->` becomes `- ->`, and `--!>` becomes `- -!>`. Nothing else
in the comment changes.

The text still goes through `visit_Text`, so comments are still
unescaped, and the `github` flavor still collapses their newlines. No
status flag was added.

Closes #116

## Before / after

Input (added to `tests/source/ExampleRSTFile.rst`):

```rst
.. a comment can contain --> or --!> without ending early.
```

Before:

```markdown
<!-- a comment can contain --> or --!> without ending early. -->
```

After (`tests/expected/ExampleRSTFile.md`):

```markdown
<!-- a comment can contain - -> or - -!> without ending early. -->
```

## Compatibility with #109

Open PR #109 (`markdown_suppress_comments`) also touches
`visit_comment`: it adds an early `raise nodes.SkipNode`. This PR only
changes the `_push_context` line, so the two are compatible.

## Commands

- `make lint`: passed (black, flake8, pylint 10.00/10)
- `make test`: passed (diff tests, 16 pytest tests, 100% coverage)

8 of 8 new or added lines in 2 files covered. (100.0%)

775 of 775 relevant lines covered (100.0%)

4.0 hits per line