[tor-bugs] #26942 [Core Tor/Tor]: Privcount blinding and encryption: Rust code conventions

Tor Bug Tracker & Wiki blackhole at torproject.org
Mon Jul 30 00:19:54 UTC 2018


#26942: Privcount blinding and encryption: Rust code conventions
-------------------------------------------------+-------------------------
 Reporter:  teor                                 |          Owner:  teor
     Type:  defect                               |         Status:
                                                 |  needs_review
 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:
-------------------------------------------------+-------------------------

Comment (by 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

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/26942#comment:4>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online


More information about the tor-bugs mailing list