-
Notifications
You must be signed in to change notification settings - Fork 215
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix readme and examples #395
Conversation
} | ||
``` | ||
|
||
### With precise events |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We do still talk about that in lib.rs. It's a planned feature but for now completely wrong. As we always emit precise events.
README.md
Outdated
|
||
The examples below are aspirational only, to preview what the final release may | ||
have looked like. They may not work. Refer to [the API documentation][docs] instead. | ||
|
||
```rust | ||
use notify::{RecommendedWatcher, RecursiveMode, Result, watcher}; | ||
use std::time::Duration; | ||
use notify::{RecommendedWatcher, RecursiveMode, Watcher}; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Our lib.rs example also differs slightly, in that it's not using channels.
One possible way, to keep them in sync, is to use |
cf2278f
to
fcaeb0e
Compare
We don't have to do MSRV check on examples, change the below notify/.github/workflows/main.yml Lines 45 to 51 in fcaeb0e
- if: matrix.version != 'stable'
+ if: matrix.version == 'nightly' (I don't remember why we ignore it on stable though...) I'm going to cleanup CI config in another PR. |
examples/watcher_kind/README.me
Outdated
@@ -0,0 +1,3 @@ | |||
# Watcher kind example |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo on file extension?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
uh yeah, also thanks for reviewing but just to make sure: It's not finished, just had some time yesterday night
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alright, ping me if it's ready :)
393ee31
to
cf37946
Compare
6c48112
to
2aebb61
Compare
Next step would be either a last RC or a release. |
I guess a RC release would be preferred as we have some changes since the last release? |
0afcc27
to
d6e701e
Compare
52de274
to
1174daa
Compare
63c1550
to
6b09dd0
Compare
Rework docs for v5 release.
Also includes cargo fmt and comments for the examples.
Fixes #393, fixes #420
Related to #249