getodk / getodk/docs

rethink how spelling warning is avoided

Open
#534 2 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

In reference to https://github.com/opendatakit/docs/pull/532#issuecomment-367795370, https://github.com/djungelorm/sphinx-tabs/pull/21

------

Edit from @adammichaelwood ---

The spell-check builder has a conflict with the tabs feature.
My solution to fixing this was a bit hacky (copy spelling errors into file and then raise error if file is not empty). What I didn't know at the time was (as noted below) there is a better way to do this (suppressing warnings coming from the tabs extension).

This is low priority, but we should probably do it at some point because I think it is long-term easier to think about (and therefore easier to maintain).

Contributor guide

Open the contributing guide

Research direction

Start with the linked docs pull request and the sphinx-tabs pull request, then trace the spell-check builder and tabs-extension warning interaction described in the issue. Done means replacing the current copied-error-file workaround with warning suppression and confirming the documentation spell-check build still reports spelling errors correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 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.