-
Notifications
You must be signed in to change notification settings - Fork 190
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Ensure that we are complying with Rust API Guidelines #191
Milestone
Comments
It would be good to run through this when we're ready to release a |
bors bot
added a commit
that referenced
this issue
Apr 20, 2019
398: add the categories and keywords r=Dylan-DPC a=kinggoesgaming **I'm submitting a(n)** other # Description Add the categories and keywords in the `Cargo.toml` # Motivation Complete Documentation -> C-METADATA requirement # Tests N/A # Related Issue(s) #191 -> (C-METADATA) Co-authored-by: Hunar Roop Kahlon <[email protected]>
@KodrAus @Dylan-DPC We should get these sorted out now... right now 33 points out of 55 are checked.. lets make it 55 edit: make it 34 |
bors bot
added a commit
that referenced
this issue
Mar 15, 2020
466: Substitute unwrap for ? operator r=Dylan-DPC a=amadeusine <!-- If this PR is a breaking change, ensure that you are opening it against the `breaking` branch. If the pull request is incomplete, prepend the Title with WIP: --> **I'm submitting a** refactor (and fixes for test cases). # Description This PR addresses C-QUESTION-MARK in the roadmap for #191. The examples have been updated to accommodate for the `?` operator instead of `.unwrap` or `try!`. # Motivation UUID can move forward with other portions of documentation given this has been completed. # Tests <!-- How are these changes tested? --> All existing tests remain successful after changes. # Related Issue(s) #191 Co-authored-by: Samuel Lim <[email protected]>
bors bot
added a commit
that referenced
this issue
Nov 6, 2020
466: Substitute unwrap for ? operator r=KodrAus a=amadeusine <!-- If this PR is a breaking change, ensure that you are opening it against the `breaking` branch. If the pull request is incomplete, prepend the Title with WIP: --> **I'm submitting a** refactor (and fixes for test cases). # Description This PR addresses C-QUESTION-MARK in the roadmap for #191. The examples have been updated to accommodate for the `?` operator instead of `.unwrap` or `try!`. # Motivation UUID can move forward with other portions of documentation given this has been completed. # Tests <!-- How are these changes tested? --> All existing tests remain successful after changes. # Related Issue(s) #191 Co-authored-by: Samuel Lim <[email protected]> Co-authored-by: Hunar Roop Kahlon <[email protected]> Co-authored-by: Samuel Lim <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
uuid
put two~~
around it to cross it out.as_
,to_
,into_
conventions (C-CONV)Methods on collections that produce iterators followiter
,iter_mut
,into_iter
(C-ITER)Iterator type names match the methods that produce them (C-ITER-TY)Copy
,Clone
,Eq
,PartialEq
,Ord
,PartialOrd
,Hash
,Debug
,Display
,Default
From
,AsRef
,AsMut
(C-CONV-TRAITS)FromIterator
andExtend
(C-COLLECT)Serialize
,Deserialize
(C-SERDE)Send
andSync
where possible (C-SEND-SYNC)Hex
,Octal
,Binary
formatting (C-NUM-FMT)Uuid
and associated adapters dont needOctal
andBinary
formatting.Generic reader/writer functions takeR: Read
andW: Write
by value (C-RW-VALUE)Input syntax is evocative of the output (C-EVOCATIVE)Macros compose well with attributes (C-MACRO-ATTR)Item macros work anywhere that items are allowed (C-ANYWHERE)Item macros support visibility specifiers (C-MACRO-VIS)Type fragments are flexible (C-MACRO-TY)?
, nottry!
, notunwrap
(C-QUESTION-MARK)readme, keywords, categories
Smart pointers do not add inherent methods (C-SMART-PTR)Operator overloads are unsurprising (C-OVERLOAD)Only smart pointers implementDeref
andDerefMut
(C-DEREF)bool
orOption
(C-CUSTOM-TYPE)Types for a set of flags arebitflags
, not enums (C-BITFLAG)Destructors that may block have alternatives (C-DTOR-BLOCK)Debug
(C-DEBUG)Debug
representation is never empty (C-DEBUG-NONEMPTY)The text was updated successfully, but these errors were encountered: