Conversation
|
All alerts resolved. Learn more about Socket for GitHub. This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored. Ignoring alerts on:
|
|
@SocketSecurity allow num-bigint@0.3.3 |
|
@SocketSecurity ignore num-bigint@0.3.3 |
src/lib.rs
Outdated
| //! To run the protocol, you need to call the [`start`] function. See the | ||
| //! repository [readme](https://github.com/dfns/LFDT-Lockness/blob/m/README.md) | ||
| //! for more information on how to set up the parameters |
There was a problem hiding this comment.
why not #[doc = include_str!("../README.md")]? Then the doc examples will be automatically tested. Otherwise we will not notice if/when it breaks.
There was a problem hiding this comment.
Remind me, why don't we simply include the readme in any other lockness projects? I was mindlessly copying from them
There was a problem hiding this comment.
depends on what you have in readme, whether you have links to structs (which are not correctly resolved in readme) and examples (hidden lines that start with #), you may need something more advanced than include_str!
There was a problem hiding this comment.
I don't recall any project in which crate docs would say "go to readme" though
There was a problem hiding this comment.
Yes, that last part is my invention =)
There was a problem hiding this comment.
But now that you do use # in examples, readme looks ugly:
There was a problem hiding this comment.
cargo-readme generates a readme that has # lines in examples removed. It's setup we have pretty much in every repo. If you don't want to mess with it, I think it's better to an empty readme that has link to docs.rs.
There was a problem hiding this comment.
Oh shit I forgot to read the readme itself. I find the approach with cargo-readme annoying, so I'd prefer to have an almost-empty readme
There was a problem hiding this comment.
After rewriting the example to use futures, the repository readme also looks nice as it doesn't use any #, I think this could be left as is: https://github.com/dfns/tecdh/blob/38184eba051eba237202c9e2d4a9ca335196b7f5/README.md
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
2 participants
The api docs were already pretty good, so I added a readme with an example usage, inspired by cggmp and givre