Closed jackiekazil closed 1 year ago
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.
I looked around if anyone had done this:
pyspelling
instead: https://github.com/pytorch/tutorials/blob/44bcbdc2dd349765077c767d433196832e262777/.github/workflows/spelling.yml#L17If 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
.
For tracking -- the ticket was moved here: https://github.com/codespell-project/actions-codespell/issues/42
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 --- 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
For some reason the output for intro_tutorial.ipynb hasn't been cleared. Will clear it now.
I know why, it's because #1665 was merged into doc_builds
instead of main
.
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