Skip to content
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

Use precommit to normalize codebase #3566

Open
wants to merge 23 commits into
base: main
Choose a base branch
from

Conversation

jasongrout
Copy link
Member

I've seen several Jupyter projects adopt precommit (thanks @blink1073!). For fun, I copied JupyterLab's precommit file and tried it out here.

@github-actions
Copy link

Binder 👈 Launch a binder notebook on branch jasongrout/ipywidgets/precommit

Untitled.ipynb Outdated Show resolved Hide resolved
@jasongrout jasongrout modified the milestones: 8.0, 8.0.x, 8.1 Aug 26, 2022
@jasongrout
Copy link
Member Author

It seems that 3251bc2 introduces a circular dependency or something - we can't even import ipywidgets

The formatter removed the spaces in the test docstring, so we need to update the assertion.
@jasongrout jasongrout force-pushed the precommit branch 2 times, most recently from 5bc08eb to 9da7f00 Compare October 24, 2022 21:04
It seems the documentation test is running out of time. Let's try 3.11 to see if it is faster.
@jasongrout jasongrout mentioned this pull request Dec 19, 2022
3 tasks
@bollwyvl
Copy link
Contributor

Yep, this would be good. Would be interesting to rekick this to see if anything improves the CI situation.

@bollwyvl
Copy link
Contributor

As discussed on #3673: potentially consider adding to prettier config:

printWidth: 88     # to align with `black`
proseWrap: always  # to improve narrative diffs

Also:

  • jupyter-black
  • and some way of formatting/normalizing markdown cells of notebooks...
    • I don't yet have a good answer for this, though not for lack of trying: prettier still seems to give better results over mdformat, but is relatively lousy at many small inputs called from python
    • perhaps a prettier-plugin-ipynb would be an option, but out of scope for ipywidgets

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants