Skip to content

Write test to detect unescaped double-underscore and single-underscore values in docstrings #1189

Open
@Strilanc

Description

@Strilanc

These are almost always intended to refer to magic methods, but markdown/rst/etc interpret it as emphasis and remove the underscores. We should detect that this is happening and raise errors.

Metadata

Metadata

Assignees

Labels

area/docsarea/sitecomplexity/lowintroduces/modifies 1-2 concepts, should take 1-2 days max for an advanced contributorgood first issueThis issue can be resolved by someone who is not familiar with the codebase. A good starting issue.no QC knowledge neededWant to contribute to Cirq, but don't know quantum computing? This issue is for you.triage/acceptedA consensus emerged that this bug report, feature request, or other action should be worked on

Type

No type

Projects

Status

No status

Relationships

None yet

Development

No branches or pull requests

Issue actions