Expand docs for ASYNC109#13146
Expand docs for ASYNC109#13146AlexWaygood merged 7 commits intoastral-sh:mainfrom jamesbraza:better-async109-docs
ASYNC109#13146Conversation
|
AlexWaygood
left a comment
There was a problem hiding this comment.
Thanks! I agree the docs for this function can be improved, and I think this is a step in the right direction overall. However, I'm not sure the PR fully addresses @jakkdl's comments in #12353 (comment) and #12353 (comment). It would be great if the rule's docs could attempt to give a proper explanation of why the rule exists in the first place (to help enforce opinionated design decisions relating to a broader philosophy of how structured concurrency works), probably linking to https://vorpus.org/blog/some-thoughts-on-asynchronous-api-design-in-a-post-asyncawait-world/#timeouts-and-cancellation.
I guess those updates don't necessarily need to be made in this PR, but I don't think this PR is sufficient to close out #12353 as it currently stands
crates/ruff_linter/src/rules/flake8_async/rules/async_function_with_timeout.rs
Outdated
Show resolved
Hide resolved
crates/ruff_linter/src/rules/flake8_async/rules/async_function_with_timeout.rs
Outdated
Show resolved
Hide resolved
|
Alright, I just added a small blurb mentioning structured concurrency and linking that blog post 👌 Thanks for the detailed and thoughtful review |
CodSpeed Performance ReportMerging #13146 will degrade performances by 5.48%Comparing Summary
Benchmarks breakdown
|
Summary
Documenting when to use or not use ASYNC109 a bit more.
Closes #12353
Test Plan
It wasn't tested