You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@milagro.apache.org by GitBox <gi...@apache.org> on 2019/06/28 04:01:38 UTC

[GitHub] [incubator-milagro-crypto-rust] kirk-baird opened a new issue #1: Formatting for Crates.io

kirk-baird opened a new issue #1: Formatting for Crates.io
URL: https://github.com/apache/incubator-milagro-crypto-rust/issues/1
 
 
   # Current Behaviour
   
   Currently the comments are in the form `/* ... */`, which means they won't generate any documentation by cargo. 
   
   # Proposed Changes
   
   Change the comment style to use `///` where documentation is desired (e.g. before public functions). Use `//` where comments should not be included in the documentation.
   
   # Additional Comments
   
   This will improve the documentation in https://docs.rs/amcl/0.2.0/amcl/

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services