Skip to content

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

Open
@Strilanc

Description

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

Labels

area/sitegood first issueThis issue can be resolved by someone who is not familiar with the codebase. A good starting issue.kind/docsDocumentation related problems, ideas, requestskind/healthFor CI/testing/release process/refactoring/technical debt itemsno 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