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.

Sign up for GitHub

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

Jump to bottom

Add Darglint Checks #2459

Closed
rbebb opened this issue Feb 2, 2023 · 3 comments
Closed

Add Darglint Checks #2459

rbebb opened this issue Feb 2, 2023 · 3 comments

Comments

@rbebb
Copy link

rbebb commented Feb 2, 2023 •
edited
Loading

It would be amazing if darglint’s checks/rules were added to ruff. darglint’s GitHub repo was archived at the end of last year and it’s also quite slow.

pydocstyle’s checks only check to make sure parameters in the function match the parameters in the docstring. It doesn’t check that returns, exceptions raised, and yields are documented in the docstring.
@edgarrmondragon
Copy link
Contributor

Duplicate of #458

@charliermarsh
Copy link
Member

Everyone wants darglint 😂

@rbebb
Copy link
Author

rbebb commented Feb 2, 2023

@charliermarsh Haha I’m sure! Sorry that I didn’t come across that ticket before making a new one. I appreciate you linking the original ticket!

edgarrmondragon added a commit to meltano/sdk that referenced this issue Feb 27, 2023
@edgarrmondragon
ci: Use Ruff to lint project
a9919ff 
- Auto-fixed unused imports (F401)
- Fixed some unused variables and redefined test functions
- Fixed docstring conventions in `singer_sdk/helpers/_state.py`
- Fixed some imports and removed `isort` from pre-commit

Can't get rid of flake8 entirely yet due to astral-sh/ruff#2459
edgarrmondragon added a commit to meltano/sdk that referenced this issue Feb 27, 2023
@edgarrmondragon
ci: Use Ruff to lint project
d8ea33c 
- Auto-fixed unused imports (F401)
- Fixed some unused variables and redefined test functions
- Fixed docstring conventions in `singer_sdk/helpers/_state.py`
- Fixed some imports and removed `isort` from pre-commit

Can't get rid of flake8 entirely yet due to astral-sh/ruff#2459
@edgarrmondragon edgarrmondragon mentioned this issue Feb 27, 2023
Merged
edgarrmondragon added a commit to meltano/sdk that referenced this issue Feb 27, 2023
@edgarrmondragon
ci: Use Ruff to lint project
1525d76 
- Auto-fixed unused imports (F401)
- Fixed some unused variables and redefined test functions
- Fixed docstring conventions in `singer_sdk/helpers/_state.py`
- Fixed some imports and removed `isort` from pre-commit

Can't get rid of flake8 entirely yet due to astral-sh/ruff#2459
edgarrmondragon added a commit to meltano/sdk that referenced this issue Feb 27, 2023
@edgarrmondragon
ci: Use Ruff to lint project
e8d9cd5 
- Auto-fixed unused imports (F401)
- Fixed some unused variables and redefined test functions
- Fixed docstring conventions in `singer_sdk/helpers/_state.py`
- Fixed some imports and removed `isort` from pre-commit

Can't get rid of flake8 entirely yet due to astral-sh/ruff#2459
edgarrmondragon added a commit to meltano/sdk that referenced this issue Mar 1, 2023
@edgarrmondragon
ci: Use Ruff to lint project
e0feb44 
- Auto-fixed unused imports (F401)
- Fixed some unused variables and redefined test functions
- Fixed docstring conventions in `singer_sdk/helpers/_state.py`
- Fixed some imports and removed `isort` from pre-commit

Can't get rid of flake8 entirely yet due to astral-sh/ruff#2459
edgarrmondragon added a commit to meltano/sdk that referenced this issue Mar 1, 2023
@edgarrmondragon
ci: Use Ruff to lint project
2029dd8 
- Auto-fixed unused imports (F401)
- Fixed some unused variables and redefined test functions
- Fixed docstring conventions in `singer_sdk/helpers/_state.py`
- Fixed some imports and removed `isort` from pre-commit

Can't get rid of flake8 entirely yet due to astral-sh/ruff#2459
edgarrmondragon added a commit to meltano/sdk that referenced this issue Mar 1, 2023
@edgarrmondragon
ci: Use Ruff to lint project (#1462)
dc64d27 
- Auto-fixed unused imports (F401)
- Fixed some unused variables and redefined test functions
- Fixed docstring conventions in `singer_sdk/helpers/_state.py`
- Fixed some imports and removed `isort` from pre-commit

Can't get rid of flake8 entirely yet due to astral-sh/ruff#2459
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@charliermarsh @edgarrmondragon @rbebb