Python
/
ruff
mirror of https://github.com/astral-sh/ruff
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[`flake8-async`] Fix references in documentation not displaying (#12467) 

## Summary

Fix references in documentation of several `ASYNC` rules not displaying

## Test Plan

Validated documentation now displays correctly
This commit is contained in:
Auguste Lalande 2024-07-22 19:38:13 -04:00 committed by GitHub
parent ef1ca0dd38
commit b2d3a05ee4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
crates/ruff_linter/src/rules/flake8_async/rules/async_busy_wait.rs
View File

@ -34,9 +34,10 @@ use crate::settings::types::PreviewMode;
/// await DONE.wait() /// await DONE.wait()
/// ``` /// ```
/// ///
/// [`asyncio` events]: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Event /// ## References
/// [`anyio` events]: https://trio.readthedocs.io/en/latest/reference-core.html#trio.Event /// - [`asyncio` events](https://docs.python.org/3/library/asyncio-sync.html#asyncio.Event)
/// [`trio` events]: https://anyio.readthedocs.io/en/latest/api.html#anyio.Event /// - [`anyio` events](https://trio.readthedocs.io/en/latest/reference-core.html#trio.Event)
/// - [`trio` events](https://anyio.readthedocs.io/en/latest/api.html#anyio.Event)
#[violation] #[violation]
pub struct AsyncBusyWait { pub struct AsyncBusyWait {
module: AsyncModule, module: AsyncModule,

7
crates/ruff_linter/src/rules/flake8_async/rules/async_function_with_timeout.rs
View File

@ -37,9 +37,10 @@ use crate::settings::types::PreviewMode;
/// await long_running_task() /// await long_running_task()
/// ``` /// ```
/// ///
/// [`asyncio` timeouts]: https://docs.python.org/3/library/asyncio-task.html#timeouts /// ## References
/// [`anyio` timeouts]: https://anyio.readthedocs.io/en/stable/cancellation.html /// - [`asyncio` timeouts](https://docs.python.org/3/library/asyncio-task.html#timeouts)
/// [`trio` timeouts]: https://trio.readthedocs.io/en/stable/reference-core.html#cancellation-and-timeouts /// - [`anyio` timeouts](https://anyio.readthedocs.io/en/stable/cancellation.html)
/// - [`trio` timeouts](https://trio.readthedocs.io/en/stable/reference-core.html#cancellation-and-timeouts)
#[violation] #[violation]
pub struct AsyncFunctionWithTimeout { pub struct AsyncFunctionWithTimeout {
module: AsyncModule, module: AsyncModule,

7
crates/ruff_linter/src/rules/flake8_async/rules/cancel_scope_no_checkpoint.rs
View File

@ -32,9 +32,10 @@ use crate::settings::types::PreviewMode;
/// await awaitable() /// await awaitable()
/// ``` /// ```
/// ///
/// [`asyncio` timeouts]: https://docs.python.org/3/library/asyncio-task.html#timeouts /// ## References
/// [`anyio` timeouts]: https://anyio.readthedocs.io/en/stable/cancellation.html /// - [`asyncio` timeouts](https://docs.python.org/3/library/asyncio-task.html#timeouts)
/// [`trio` timeouts]: https://trio.readthedocs.io/en/stable/reference-core.html#cancellation-and-timeouts /// - [`anyio` timeouts](https://anyio.readthedocs.io/en/stable/cancellation.html)
/// - [`trio` timeouts](https://trio.readthedocs.io/en/stable/reference-core.html#cancellation-and-timeouts)
#[violation] #[violation]
pub struct CancelScopeNoCheckpoint { pub struct CancelScopeNoCheckpoint {
method_name: MethodName, method_name: MethodName,