Skip to content

Format and lint - #17

Merged
ablech merged 7 commits into
mainfrom
format-and-lint
Nov 10, 2026
Merged

ablech merged 7 commits into
mainfrom
format-and-lint

Conversation

@ablech

@ablech ablech commented Nov 10, 2026

Copy link
Copy Markdown
Member

E. format-and-lint

  • [tool.ruff]: default line length (88), the agreed rules, src/openquad/data/ excluded
    from formatting since those tables move in step 3. Also *.md excluded, at the
    maintainer's choice: ruff 0.17 formats code blocks in Markdown, and the README
    examples keep their hand-written layout
  • .pre-commit-config.yaml with pinned versions: ruff v0.17.2, codespell v2.4.3,
    check-jsonschema 0.39.0, validate-pyproject v0.27, the newest at least two weeks old.
    Standard isolated hook environments, approved by the maintainer; the one-off
    download took 25 s
  • Lint job in ci.yml: ubuntu, Python 3.13, prek run --all-files, same config as
    local. Pass waits for it
  • One commit with only ruff format (f3fde52), listed in .git-blame-ignore-revs.
    Tests unchanged (57 passed, 5 xfailed); syntax trees equal up to docstring
    whitespace. The entry needs the hash to survive the merge: merge commit, no rebase
  • Remaining findings go under per-file-ignores, by rule per file: 113 findings in 19
    files. Not fixed
  • codespell: 21 typos fixed in comments, docstrings and docs; reson (J. Magn.
    Reson.) on the ignore list
  • Added: raw docstrings in grid.py and fibonacci.py, at the maintainer's choice,
    before the format commit. See "Hidden syntax warnings" under findings

ablech and others added 7 commits November 10, 2026 03:59
Line length stays at the default of 88. The data tables are excluded, as
they will move out of the package.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
\theta was read as a tab and \phi as an invalid escape. Since warnings
fail the tests, editing these files made the suite fail on import.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Formatting only, produced by ruff 0.17.2. Syntax trees are unchanged up
to whitespace in docstrings.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The 113 findings present after formatting are listed by rule per file,
not fixed. New files get the full rule set.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Comments, docstrings and documentation only. Reson, as in J. Magn.
Reson., is added to the codespell ignore list.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Ruff check and format, codespell, and validation of the workflow and of
pyproject.toml, at pinned versions. The new Lint job runs the same
checks, and Pass now also waits for it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ablech
ablech merged commit 4b73160 into main Nov 10, 2026
5 checks passed
@ablech
ablech deleted the format-and-lint branch November 10, 2026 03:14
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.

1 participant