[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]
Re: [tor-bugs] #26942 [Core Tor/Tor]: Privcount blinding and encryption: Rust code conventions
#26942: Privcount blinding and encryption: Rust code conventions
-------------------------------------------------+-------------------------
Reporter: teor | Owner: teor
Type: defect | Status:
| merge_ready
Priority: Medium | Milestone: Tor:
| 0.3.5.x-final
Component: Core Tor/Tor | Version:
Severity: Normal | Resolution:
Keywords: privcount, 035-roadmap-master, 035 | Actual Points:
-triaged-in-20180711, rust |
Parent ID: #25669 | Points:
Reviewer: | Sponsor:
-------------------------------------------------+-------------------------
Changes (by teor):
* status: needs_revision => merge_ready
Comment:
Replying to [comment:4 chelseakomlo]:
> The fix for the function name looks good to me.
>
> I did another glance through for Rust conventions, and another
convention fix I noticed is to follow Rust documentation conventions (see
> https://doc.rust-lang.org/book/first-edition/comments.html and
https://doc.rust-lang.org/book/second-edition/ch14-02-publishing-to-
crates-io.html)
>
> For example,
https://github.com/teor2345/privcount_shamir/blob/master/rust/src/shamir.rs#L22
should probably be `///` to indicate a documentation comment and
https://github.com/teor2345/privcount_shamir/blob/master/rust/src/shamir.rs#L1
should probably be `//!` to indicate a crate/module comment
Thanks!
I'd like to fix the format of the doc comments when I add more doc
comments in #26940.
--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/26942#comment:6>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online
_______________________________________________
tor-bugs mailing list
tor-bugs@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs