darglint becomes pydoclint
#3012
Conversation
strickvl
added
internal
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
|
New and removed dependencies detected. Learn more about Socket for GitHub ↗︎
🚮 Removed packages: pypi/[email protected] |
| @@ -345,7 +345,7 @@ def _delete_pod(self, pod_name: str) -> None: | |||
| pod_name: Name of the Pod to delete. | |||
|
|
|||
| Raises: | |||
| subprocess.CalledProcessError: If the kubectl call to delete | |||
| e: If the kubectl call to delete | |||
There was a problem hiding this comment.
That's quite a downgrade here in information I'd say. Any way we can add an ignore here and still have the actual error type?
There was a problem hiding this comment.
Yeah so pydoclint native doesn't actually allow these custom ignores at all, unless you use it in 'flake8 plugin mode'. We don't want to add flake8 back in, so I'd say that isn't really an option. ruff is slowly adding it in (i.e. use pydoclint as a backend to perform the checks for DOC-... error codes) but it is only available in preview model and it doesn't currently work too well. So I'd say we can either leave it this way + upgrade later when ruff support is finally stable, or we can just hold off completely until ruff support comes. I think it'd probably be a few months realistically before that's there, going off the pace of the comments etc on the GH issue.
Darglint is slow + has been archived as a project for a while.
pydoclintis a replacement, with a few extra tricks around docstring validation. Best of all, it's much faster than darglint (which we had to give its own CI runners, such was the sluggishness), so I've added this back into the linting script (where it used to live, once upon a time).The
ruffteam / community are working to integrate pydoclint intoruffproper, but the issue has been open for a while and it doesn't quite yet work the way we want (despite being available on thepreviewfeature flag).