-
Notifications
You must be signed in to change notification settings - Fork 5.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add spelling and docstring enforcement #6669
Conversation
8f87e53
to
cb7c615
Compare
@@ -69,6 +69,9 @@ jobs: | |||
- uses: actions/checkout@v3 | |||
- uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1 | |||
- run: | | |||
sudo apt-get update | |||
sudo apt install enchant-2 # for spelling |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does it mean we would need to install that package locally if we want to build the docs manually?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah ok just saw the try except
block below, so it's probably fine and does prevent building the docs if the package is missing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, on Windows it works automatically but on other systems you have to separately install enchant
, so we add this block to avoid requiring the c library on posix.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
No description provided.