#26942 closed defect (fixed)

Privcount blinding and encryption: Rust code conventions

Reported by: teor Owned by: teor
Priority: Medium Milestone: Tor: 0.3.5.x-final
Component: Core Tor/Tor Version:
Severity: Normal Keywords: privcount, 035-roadmap-master, 035-triaged-in-20180711, rust
Cc: teor, nickm, chelseakomlo Actual Points:
Parent ID: #25669 Points:
Reviewer: Sponsor:

Description

Child Tickets

Change History (7)

comment:1 Changed 13 months ago by teor

Please see my branch bug26946 at https://github.com/teor2345/privcount_shamir.git

It includes changes from rustfmt, #26942, and #26946.

comment:2 Changed 13 months ago by teor

Status: assignedneeds_review

comment:4 Changed 13 months ago 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

comment:5 Changed 13 months ago by chelseakomlo

Status: needs_reviewneeds_revision

comment:6 in reply to:  4 Changed 13 months ago by teor

Status: needs_revisionmerge_ready

Replying to 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.

comment:7 Changed 13 months ago by nickm

Resolution: fixed
Status: merge_readyclosed

Merged!

Note: See TracTickets for help on using tickets.