Skip to content

docs(test): clarify reason for skipped CommonMark roundtrip tests#636

Open
satyaij6 wants to merge 1 commit intoaccordproject:mainfrom
satyaij6:investigate-commonmark-roundtrip
Open

docs(test): clarify reason for skipped CommonMark roundtrip tests#636
satyaij6 wants to merge 1 commit intoaccordproject:mainfrom
satyaij6:investigate-commonmark-roundtrip

Conversation

@satyaij6
Copy link

Description

This PR clarifies the reason why the CommonMark roundtrip tests are currently skipped.

The previous comment indicated that the tests “need more investigation” without explaining the nature of the issue. Based on initial investigation, the failures are due to known whitespace and normalization differences in Markdown → AST → Markdown transformations, rather than semantic errors.

This improves test readability and helps future contributors understand the limitation without re-investigating it.


Changes

  • Replaced vague TODO comment with a clear explanation of the normalization issue.
  • Updated the skipped test name to make the reason visible in test output.

Notes

  • Documentation-only update.
  • No functional or behavioral changes.
  • All tests pass with expected skips.

Related Issue


Checklist

  • Changes are limited in scope and non-breaking
  • Commit messages follow project conventions
  • Tests run successfully

Signed-off-by: satyaij6 <satyainjamuri7@gmail.com>
@mttrbrts mttrbrts enabled auto-merge (squash) February 15, 2026 21:42
@mttrbrts mttrbrts closed this Feb 24, 2026
auto-merge was automatically disabled February 24, 2026 09:35

Pull request was closed

@mttrbrts mttrbrts reopened this Feb 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants