-
Notifications
You must be signed in to change notification settings - Fork 434
Note null-terminated crate #61
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.
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does anyone have a source code link for the crate in question? I’d like to check the docs and whatnot.
I also need to refresh myself on crate criteria.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please consider updating the crate metadata with a link to the repository and more descriptive text. Examples would also be great to have to make sure people can learn what it is and how to use it.
Echoing @therealprof here. It’s outside of the Rust Embedded and more just crate etiquette in general. A readme and some examples do help folks understand why they would want to use your crate!
I’m excited to see the rationale behind why these helper functions exist and what problems they solve. I can’t quite tell from the code itself.
I have examples and such in the docs. Alas, docs.rs failed to build the crate as it was using too old rustc. I notified and will follow up here.
mathk
commented
Feb 21, 2019
Ping from triage: I propose that this should be part of the showcase first and close this PR ? @therealprof @RandomInsano objection?
Ping from triage: @therealprof crates.io page now contains a link to the repo as well as docs, but description text is still far from detailed and examples are difficult to find.
@strake Could you improve the crate description and add some examples to the crate-level docs so they can be easily found?
Brief status report: this is on my agenda; it's been a busy few weeks. I'll try to find examples for more of the API.
It's a crate of generic null-terminated arrays. I find it quite useful dealing with the C world in particular.
Wrote more docs and examples. PTAL
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry for being anal, but could you please add a README.md file to the root of your repository? Providing one short example as well as a paragraph about why it is useful would be immensely helpful to the future users of this crate.
Generally I like it, and ready to include it in the list, but clear README is my nitpick that i'd like to see addressed before.
PTAL — docs not yet (as of writing this) generated, but README up on crates.io.
@therealprof pls review again!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks better now!
It's a crate of generic null-terminated arrays. I find it quite useful dealing with the C world in particular.