Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add spellchecking to documentation

See original GitHub issue

Problem

As of #833, we won’t be doing any automated checking on .ipynb and .md files. We could get some meaningful automated feedback on these by applying spellchecking, which would both save review load, as well as find existing issues.

Suggested Improvement

add hunspell and hunspell-en to the environment
generate HTML example noteboks with nbconvert
add a custom dictionary for terms of art and branding
run hunspell during doit check on the built docs and converted notebooks

Issue Analytics

State:
Created a year ago
Comments:5

Top GitHub Comments

1reaction

bollwyvlcommented, Oct 27, 2022

Hm, thought I replied, but I think there were github (issues) issues.

Basically, we’d want to use hunspell in the places we have pytest-check-links, against (nearly) the same set of documents. It is not available from pip, so it wouldn’t go in requirements, and it also needs a dictionary, in this case hunspell-en.

The other file that will be needed is a docs/dictionary.txt.

Here is a concrete ancestor of our doit setup using it in a doit task, pointed at that dictionary. Of note, that dictionary is super long, and I’ve found it best to try to cajole as many “code jargon” words as possible into appropriate tags, and skipping the generated index page. We’ll almost certainly have…

Jupyter
JupyterLab
JupyterLite

But there will be many more! Another thing i’ve learned is to keep that file sorted, adding another lint:dictionary task.

If that fails entirely another approach is to rewrite the HTML before emitting them, but that’s a bit hard.

0reactions

bollwyvlcommented, Oct 28, 2022

Binder?

On Fri, Oct 28, 2022, 07:28 Kostya Farber @.***> wrote:

Is there anyway I can run and debug the doit tasks in concrete ancestor https://github.com/deathbeds/wxyz/search?q=hunspell to get an idea how the hunspell tasks runs?

— Reply to this email directly, view it on GitHub https://github.com/jupyterlite/jupyterlite/issues/841#issuecomment-1294939089, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAALCRDD5ERJ4S2VIPQW4RTWFPBGJANCNFSM6AAAAAARHJSQJM . You are receiving this because you authored the thread.Message ID: @.***>