Skip to content
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.

Sign up for GitHub

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

docs: add a few best practice recommendations #134

Merged
merged 1 commit into from
Oct 23, 2024
Merged

docs: add a few best practice recommendations #134

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/examples/writing-watchers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,5 @@ This example will describe how to:

.. literalinclude:: client.rs

It is recommend to follow conventions and use the `aw-watcher-<name>` naming scheme for your watcher.
It is also recommended for watchers to accept a `--testing` flag and a `--port <port>` flag to allow users to specify the port to connect to.
Loading