Improve acap-logging docs #41
Merged
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
The crate level documentation is taken from `README.md` to make it easier to ensure that crates.io, docs.rs and GitHub all show sensible documentation with minimal effort. Also update the `hello_world` example since it would not display any output by default when run in a terminal. To increase the utility of the app a bit further without increasing the complexity it is used to also demonstrate the effect of logging at other levels and of printing.
Also add a table of library crates provided by this project and where to find their documentation. This makes it easier to get an overview of what is available and where.
The documentation test is annotated with the `no_run` attribute because it fails to create a unix socket logger in GitHub Actions. In GitHub this causes it to not be syntax highlighted but I'm hoping crates.io will pick it up anyway.
apljungquist
added a commit
that referenced
this pull request
Jul 19, 2024
* upstream/main: Generate app `LICENSE` files (#44) Add acap-ssh-utils bin and lib crate (#19) Add cargo-acap-build tool (#25) Remove partially containerized workflow (#42) Improve acap-logging docs (#41) chore: Prepare logging library crate for publishing (#40) feat: Add metadata broker wrapper and example (#22) Rename environment variables controlling the Makefile (#26) Adopt dev container as primary environment (#39) Make the `build` verb build for only one target (#31) chore(deps): bump ghcr.io/devcontainers/features/common-utils (#38) chore(deps): bump log from 0.4.21 to 0.4.22 in the default group (#37) Add dev container (#36) Add link to acap-rs-app-template in `README.md` (#34) Document `python3-venv` dependency (#35) fix: Repair `Makefile` (#32)
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.
The crate level documentation is taken from
README.mdto make it easier to ensure that crates.io, docs.rs and GitHub all show sensible documentation with minimal effort.Also update the
hello_worldexample since it would not display any output by default when run in a terminal. To increase the utility of the app a bit further without increasing the complexity it is used to also demonstrate the effect of logging at other levels and of printing.