Ciw icon indicating copy to clipboard operation
Ciw copied to clipboard

add ruff.toml with default config plus numpy docstrings

Open galenseilis opened this issue 10 months ago • 3 comments

  • Adding a ruff.toml.
  • The rule set can be changed, but for the moment I want with the default given in the Ruff documentation with one added difference.
  • The added difference is setting Ruff to use NumPy's pydocstyle rather than Googles or PEP257.
    • Discussion here seems to support this choice of convention.

After there are some agreed rules for Ruff, I will start making non-breaking formatting changes.

galenseilis avatar Apr 09 '25 02:04 galenseilis

https://github.com/CiwPython/Ciw/issues/217

galenseilis avatar Apr 09 '25 03:04 galenseilis

Hi @galenseilis Can you explain a bit more about what this is please?

geraintpalmer avatar Jun 04 '25 14:06 geraintpalmer

Hi @galenseilis Can you explain a bit more about what this is please?

Absolutely. Ruff is a linting and formatting tool. What the ruff.toml specifies is configuration for when the ruff tool is used within the directory of this Python project.

If you agree that we can use Ruff for working with Ciw, then we can also review and revise the proposed config in this PR.

Let me know what you think.

galenseilis avatar Jun 04 '25 22:06 galenseilis