getodk / getodk/docs

Style check false positive on horizontal rule

Open
#596 3 comments 0 reactions 0 assignees View on GitHub
coding python
Dominant language
Python
Stars
58
Forks
160
Avg merge
5d 11h
Merged PRs (30d)
12

Description

A section separator (html: `


`) is created in sphinx with:

```

--------

```

That is: a line of a repeated single character (at least three... and I always use hyphens), surrounded by blank lines.

This is causing a false positive for `style-guide.check-label`

@ankita240796

Contributor guide

Open the contributing guide

Research direction

Start at the style-guide.check-label check and reproduce it with the Sphinx section separator shown in the issue. Trace why a line of repeated hyphens between blank lines is reported, then verify that this horizontal rule no longer produces a false positive while other label violations still do.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.