Add #Issues docs to LoopHelper

Remove release script Remove rustfmt.toml Update ci config
alexheretic · Jan 1, 2024 · b7f4399 · b7f4399
1 parent 78581a6
commit b7f4399
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 28 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -16,12 +16,12 @@ jobs:
         - windows-latest
     steps:
     - run: rustup update stable
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - run: cargo test
 
   rustfmt:
     runs-on: ubuntu-latest
     steps:
     - run: rustup update stable
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - run: cargo fmt -- --check
diff --git a/release b/release
diff --git a/rustfmt.toml b/rustfmt.toml
diff --git a/src/loop_helper.rs b/src/loop_helper.rs
@@ -9,6 +9,10 @@ use std::time::{Duration, Instant};
 /// Can limit a loop rate to a desired target using
 /// [`LoopHelper::loop_sleep`](struct.LoopHelper.html#method.loop_sleep).
 ///
+/// # Issues
+/// There are known limitations/flaws, see [#19](https://github.com/alexheretic/spin-sleep/issues/19).
+/// `LoopHelper` will probably be deprecated for removal in the future.
+///
 /// # Example
 ///
 /// ```no_run