docs: misc improved docs, including rust watcher example #132
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
There was a problem hiding this comment.
❌ Changes requested. Reviewed everything up to 27903cb in 48 seconds
More details
- Looked at
298lines of code in8files - Skipped
0files when reviewing. - Skipped posting
2drafted comments based on config settings.
1. src/examples/client.rs:19
- Draft comment:
Thehostnamefield in theBucketstruct is set to an empty string. This might be incorrect or unintended. Typically, the hostname should be set to a meaningful value. - Reason this comment was not posted:
Confidence of 30% on close inspection, compared to threshold of 50%.
2. src/examples/minimal_client.rs:18
- Draft comment:
Thehostnamefield in theBucketstruct is set to an empty string. This might be incorrect or unintended. Typically, the hostname should be set to a meaningful value. - Reason this comment was not posted:
Marked as duplicate.
Workflow ID: wflow_YkJfdVXnz7mWIYvU
Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
| edition = "2021" | ||
|
|
||
| [dependencies] | ||
| aw-client-rust = { git = "https://github.com/ActivityWatch/aw-server-rust.git", branch = "master" } |
There was a problem hiding this comment.
Depending on the master branch of a git repository for dependencies can lead to unstable builds. Consider using specific versions or tags to ensure stability.
ErikBjare
approved these changes
Jul 1, 2024
ErikBjare
changed the title
|
@ErikBjare the syntax highlighting is not working for the rust examples, I was going to investigate it later. But I can include it in the next PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary:
Updated documentation with new Rust examples, fixed Python example, and added configuration details for
aw-server-rust.Key points:
src/configuration.rstto includehost,port, andcorsoptions foraw-server-rust.src/examples/cargo.tomlfor Rust client dependencies.src/examples/client.pyto fixcreate_bucketfunction call.src/examples/client.rswith a detailed Rust client example.src/examples/minimal_client.rswith a minimal Rust client example.src/examples/writing-watchers.rstto include Rust examples for writing watchers.src/importers.rst.aw-watcher-lastfmto media watchers insrc/watchers.rst.Generated with ❤️ by ellipsis.dev