5 add docs for crate usage #14
Conversation
# Conflicts: # src/can.rs # src/tests/can.rs
There was a problem hiding this comment.
A good start and nice examples. But the docs should be reorganized a bit:
- Move the docs of the
canmodule to crate level, as these act as a nice starting point for the user - Add comment description to all the modules
- Add shorter + deeper descriptions and examples to the corresponding modules. In detail:
a)canmodule: Explain how to configure the CAN controller (e.g. FIFO configuraiton)
b)messagemodule: Explain the two CAN types (CAN FD and CAN 2.0) and add short examples (just how to construct them)
src/lib.rs
Outdated
| @@ -11,6 +11,8 @@ pub mod status; | |||
|
|
|||
| pub mod filter; | |||
| pub mod message; | |||
|
|
|||
| pub mod example; | |||
There was a problem hiding this comment.
Please add an example feature flag for. So the library user has the ability to remove the example code for prod. usage.
See LTC681X crate as reference:
https://github.com/atlas-aero/rt-LTC681X/blob/6c4407091672e7dd2e91dda18d0a686246e4fbf2/Cargo.toml#L25
There was a problem hiding this comment.
Added now, example feature included by default as in rt-LTC681x crate
So the doc example should be in a separate file? |
The intent was, to move the docs of Furthermore, you might combine the RX and TX example into one. It is common practice that only one complete example is shown on the first documentation page. And then detailed examples are shown in the individual sub-pages or modules. |
|
Should be ready for another review now, I included the changes from #20 as well. |
| @@ -0,0 +1,121 @@ | |||
| use alloc::vec; | |||
There was a problem hiding this comment.
Please add a short description, that the example code may be removed by disabling the example feature flag.
|
Any updates on this? |
It's close to being finished, just need to update docs to match latest commits |
|
Should be updated with latest PRs, added a couple of comments and an example for constructing a CAN FD message as well |
There was a problem hiding this comment.
Please check, seems several of the previous review comments are not processed yet:
- 5 add docs for crate usage #14 (comment)
- 5 add docs for crate usage #14 (comment)
- 5 add docs for crate usage #14 (comment)
- 5 add docs for crate usage #14 (comment)
- 5 add docs for crate usage #14 (comment)
- 5 add docs for crate usage #14 (comment)
- 5 add docs for crate usage #14 (comment)
- 5 add docs for crate usage #14 (comment)
- 5 add docs for crate usage #14 (comment)
- 5 add docs for crate usage #14 (comment)
- 5 add docs for crate usage #14 (comment)
src/message.rs
Outdated
| //! | ||
| //!use bytes::Bytes; | ||
| //!use mcp2517::message::{CanFd,TxMessage}; | ||
| //!use embedded_can::{Id,StandardId}; | ||
| //! |
There was a problem hiding this comment.
| //! | |
| //!use bytes::Bytes; | |
| //!use mcp2517::message::{CanFd,TxMessage}; | |
| //!use embedded_can::{Id,StandardId}; | |
| //! | |
| //!# use bytes::Bytes; | |
| //!# use mcp2517::message::{CanFd,TxMessage}; | |
| //!# use embedded_can::{Id,StandardId}; | |
| //!# |
|
Comments addressed now, should be ready for review |
No description provided.