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

Jump to bottom

Add docs for crate usage #5

Closed
marius-meissner opened this issue Apr 18, 2024 · 0 comments · Fixed by #14
Closed

Add docs for crate usage #5

marius-meissner opened this issue Apr 18, 2024 · 0 comments · Fixed by #14
Assignees
@HusseinAbdelhamid
Labels
documentation Improvements or additions to documentation

Comments

@marius-meissner
Copy link
Member

We should add some module documentation using the Rust doc system covering the following topics:

  1. Minimal example of using the library
  2. Configuration
  3. Sending and receiving Rust messages

Maybe have a look at pca9539 crate as an example:
https://docs.rs/pca9539/0.3.0/pca9539/
@marius-meissner marius-meissner added the documentation Improvements or additions to documentation label Apr 18, 2024
@marius-meissner marius-meissner mentioned this issue Apr 18, 2024
Merged
HusseinAbdelhamid added a commit that referenced this issue Sep 3, 2024
@HusseinAbdelhamid
#5 remove duplicate code
c56e130
HusseinAbdelhamid added a commit that referenced this issue Sep 3, 2024
@HusseinAbdelhamid
#5 add example spi and clock
b7a8b43
HusseinAbdelhamid added a commit that referenced this issue Sep 3, 2024
@HusseinAbdelhamid
#5 merge with #11
c5bab20
HusseinAbdelhamid added a commit that referenced this issue Sep 3, 2024
@HusseinAbdelhamid
#5 add rust doc examples
eec6a5a
@HusseinAbdelhamid HusseinAbdelhamid linked a pull request Sep 3, 2024 that will close this issue
5 add docs for crate usage #14
Merged
HusseinAbdelhamid added a commit that referenced this issue Sep 3, 2024
@HusseinAbdelhamid
#5 add .vscode to .gitignore
6684a50
HusseinAbdelhamid added a commit that referenced this issue Sep 5, 2024
@HusseinAbdelhamid
#5 add bytes patch to library Cargo.toml
effef23
HusseinAbdelhamid added a commit that referenced this issue Sep 10, 2024
@HusseinAbdelhamid
#5 add config/message examples
790e6f6
HusseinAbdelhamid added a commit that referenced this issue Sep 10, 2024
@HusseinAbdelhamid
#5 add rustdocs for modules
169c950
HusseinAbdelhamid added a commit that referenced this issue Sep 10, 2024
@HusseinAbdelhamid
#5 update rustdoc examples
bd68c67
HusseinAbdelhamid added a commit that referenced this issue Sep 26, 2024
@HusseinAbdelhamid
#5 update docs + add comments + add can fd message construction example
3baffd4
HusseinAbdelhamid added a commit that referenced this issue Oct 1, 2024
@HusseinAbdelhamid
#5 modify rust docs code and comments
9562399
HusseinAbdelhamid added a commit that referenced this issue Oct 1, 2024
@HusseinAbdelhamid
#5 comment out empty lines in rustdoc
0b95c28
HusseinAbdelhamid added a commit that referenced this issue Oct 1, 2024
@HusseinAbdelhamid
#5 add example crate feature to remove example code
ff9450d
HusseinAbdelhamid added a commit that referenced this issue Oct 1, 2024
@HusseinAbdelhamid
#5 unhide use statements from main rust doc example
e8ca7f7
marius-meissner added a commit that referenced this issue Oct 2, 2024
@marius-meissner
#5: Removed trailing whitespace of main example doc
66049d4
HusseinAbdelhamid added a commit that referenced this issue Oct 14, 2024
@HusseinAbdelhamid
#5 add comment for example file
b07503a
marius-meissner added a commit that referenced this issue Oct 15, 2024
@marius-meissner
#5: Adjusted docs of example and status module
44823b6
@marius-meissner marius-meissner mentioned this issue Oct 15, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@HusseinAbdelhamid HusseinAbdelhamid

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

5 add docs for crate usage atlas-aero/rt-mcp2517
2 participants
@marius-meissner @HusseinAbdelhamid