Square brackets are incorrectly escaped in code blocks

Open
#84 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
42/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
html, python
Domain
documentation

Research direction

Start by tracing the documentation generator's code-block rendering and escaping path, since the issue names no file or test. Reproduce the shown output with square brackets, then verify that generated code blocks retain literal brackets without unwanted backslashes.

Written by the indexing model from the issue text.

Description

The square brackets are escaped with backslash, they should not be:
image

Dominant language
Python
Stars
20
Forks
25
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from boostorg/docca

All issues in boostorg/docca

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.