Skip to content

Commit

Permalink
fix doc (#380)
Browse files Browse the repository at this point in the history
  • Loading branch information
loongs-zhang authored Jan 18, 2025
2 parents f52bfce + 11e0184 commit 87ab737
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 2 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,7 @@ fn main() {
- [Work Steal Overview](core/docs/en/work-steal.md)
- [Ordered Work Steal Overview](core/docs/en/ordered-work-steal.md)
- [Coroutine Pool Overview](core/docs/en/coroutine-pool.md)
- [Hook Overview](hook/docs/en/hook.md)

[我有故事,你有酒吗?](https://github.com/acl-dev/open-coroutine-docs)

Expand Down
2 changes: 1 addition & 1 deletion core/docs/en/coroutine-pool.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ fn main() -> std::io::Result<()> {
let mut pool = CoroutinePool::default();
assert!(pool.is_empty());
pool.submit_task(
Some(String::from(task_name)),
None,
|_| {
println!("Hello, world!");
Some(2)
Expand Down
1 change: 1 addition & 0 deletions core/docs/en/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,4 @@ replacement for IO thread pools, see [why better](../en/why-better.md).
- [Work Steal Overview](../en/work-steal.md)
- [Ordered Work Steal Overview](../en/ordered-work-steal.md)
- [Coroutine Pool Overview](../en/coroutine-pool.md)
- [Hook Overview](../../../hook/docs/en/hook.md)
1 change: 1 addition & 0 deletions hook/docs/en/hook.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
todo
2 changes: 1 addition & 1 deletion hook/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
clippy::separated_literal_suffix, // conflicts with clippy::unseparated_literal_suffix
clippy::single_char_lifetime_names, // TODO: change lifetime names
)]
//! see `https://github.com/acl-dev/open-coroutine`
#![doc = include_str!("../docs/en/hook.md")]

use once_cell::sync::OnceCell;
use open_coroutine_core::co_pool::task::UserTaskFunc;
Expand Down

0 comments on commit 87ab737

Please sign in to comment.