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

Using ruff for code formatting #43

Merged
merged 4 commits into from
Mar 6, 2023
Merged

Conversation

Ce11an
Copy link
Contributor

@Ce11an Ce11an commented Feb 12, 2023

Thank you for submitting this pull request! We appreciate you spending the time to work on these changes.

What is the motivation?

Using ruff to check code formatting.

Type of Change

  • 📚 Examples / docs / tutorials / dependencies update

What does this change do?

  • Adds ruff to the Poetry dev-dependencies.
  • Adds ruff to pre-commit.
  • Changes docstrings to Google style.

ruff selects include:

  • Flake8
  • Isort
  • PEP8 naming
  • pydocstyle
  • PyUpgrade

What is your testing strategy?

Two main commands for ruff:

poetry run ruff check .

and for automated fixing:

poetry run ruff --fix .

Is this related to any issues?

#41 - This PR only implements the ruff part of this issue. A separate PR should be made for mypy.

Have you read the Contributing Guidelines?

@Ce11an
Copy link
Contributor Author

Ce11an commented Feb 12, 2023

I didn't realise, this PR fixes #36, too.

Copy link
Contributor

@tsunyoku tsunyoku left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ty!

@tobiemh tobiemh merged commit f60b3d8 into surrealdb:main Mar 6, 2023
@tobiemh tobiemh mentioned this pull request Mar 6, 2023
@Ce11an Ce11an deleted the 41-code-formatting branch March 6, 2023 19:46
maxwellflitton pushed a commit that referenced this pull request Jun 19, 2023
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.

3 participants