phpDocumentor / phpDocumentor/guides

Introduce a warning for forgotten Backticks

Open
#1,053 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

feature triage
Dominant language
PHP
Stars
36
Forks
22
Avg merge
2d 2h
Merged PRs (30d)
24

Description

Feature request

To increase the possibility to find forgotten backticks (during local rendering or before someone is going to push new changes) like in here :file:`.rst.txt' we can build in a check that examines if the number of all backticks in a rst file is even. It is clear that two forgotten backticks make the number even again. Maybe we can catch it somehow. And we have to do it in the rst parser in order to exclude backticks in code blocks , comments and everywhere else where it could spoil the calculated number of backticks.

Contributor guide

Open the contributing guide

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.

Research direction

Start by locating the RST parser and trace how it distinguishes normal text from code blocks and comments. Add the requested backtick check without counting excluded contexts, and verify that forgotten backticks produce a warning during local rendering or before changes are pushed.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.