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

Fix codespell build for tutorial docs #1661

Closed
jackiekazil opened this issue Apr 25, 2023 · 7 comments · Fixed by #1695 or #1697
Closed

Fix codespell build for tutorial docs #1661

jackiekazil opened this issue Apr 25, 2023 · 7 comments · Fixed by #1695 or #1697

Comments

@jackiekazil
Copy link
Member

Not sure if this is possible, but codespell will pick up image text and try to suggest text edits and says the build is broken.
Hoping there is a setting somewhere that we can add to ignore the image text.

Here is an example: https://github.com/projectmesa/mesa/pull/1656/files#diff-732a7eb31fbbd25075ee965837dc0092fb53c2cb64c068e60392d9bf69d9f9bbR877

Screenshot 2023-04-25 at 12 17 29 PM

Screenshot 2023-04-25 at 12 26 06 PM

@jackiekazil
Copy link
Member Author

Build is fixed... not ideal, but fixed. Codespell did not do what we wanted it to.
Thank you @catherinedevlin @martin-martin @glnnlhmn for all scrubbing in.

@rht @tpike3 @wang-boyu - we should discuss during may meeting.

@rht
Copy link
Contributor

rht commented May 10, 2023

I looked around if anyone had done this:

If the issue with ignoring png blobs is fixed, it would be a solution that can be applied to other repos containing Jupyter notebooks.

Also worth trying: https://github.com/crate-ci/typos, which is much faster than codespell.

@jackiekazil
Copy link
Member Author

For tracking -- the ticket was moved here: codespell-project/actions-codespell#42

@rht
Copy link
Contributor

rht commented May 15, 2023

Since #1694, the .ipynb outputs are always cleared, not committed to the repo. As such, there should be no more base64-encoded pngs in the repo. We should be able to re-enable codespell again.

rht added a commit to rht/mesa that referenced this issue May 15, 2023
jackiekazil pushed a commit that referenced this issue May 15, 2023
@jackiekazil
Copy link
Member Author

@rht --- I have a test branch for another ticket and it looks like the fix for notebooks broke the build - https://github.com/projectmesa/mesa/pull/1696/files

@jackiekazil jackiekazil reopened this May 15, 2023
@rht
Copy link
Contributor

rht commented May 15, 2023

For some reason the output for intro_tutorial.ipynb hasn't been cleared. Will clear it now.

@rht
Copy link
Contributor

rht commented May 15, 2023

I know why, it's because #1665 was merged into doc_builds instead of main.

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