Skip to content

add ruff.toml with default config plus numpy docstrings #263

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

galenseilis
Copy link
Contributor

  • 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
Copy link
Contributor Author

#217

@geraintpalmer
Copy link
Member

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

@galenseilis
Copy link
Contributor Author

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.

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.

2 participants