Skip to content

Instantly share code, notes, and snippets.

@brson

brson/b.md Secret

Last active February 21, 2017 21:25
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save brson/ab5808dedd65256dead709a1fb431ab0 to your computer and use it in GitHub Desktop.
Save brson/ab5808dedd65256dead709a1fb431ab0 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
b.md

byteorder evaluation 2017-02-18

Links

Prep checklist

  • Compare crate to guidelines
  • Draft tracking issue
  • Update guidelines
  • Update cookbook

Guidelines checklist

  • Naming
  • Architecture
  • Containers
  • Ownership and resource management
  • Error handling
  • Documentation
    • [n] All items have a rustdoc example (C-EXAMPLES)
    • [n] Function docs include panic conditions in "Panics" section (C-PANIC-DOC)
    • [n] Function docs include error conditions in "Errors" section (C-ERROR-DOC)
    • [n] Cargo.toml includes common headers (C-CARGO-HEADERS)
      • authors, description, documentation, homepage
      • repository, readme, keywords, categories, license
      • missing "categories"
    • [n] Cargo.toml publishes CI badges for tier 1 platforms (C-CI)
  • Unsorted guidelines
    • [y] Eagerly implement common traits (C-COMMON-TRAITS)
      • Copy, Clone, Eq, PartialEq, Ord, PartialOrd
      • Hash Debug, Display
      • Yes, but should these be implemented for phantom types?
    • [y] All public types implement Debug (C-DEBUG)
    • [-] All public types implement serde Serialize / Deserialize (C-SERDE)
      • No, but for phantom types?
    • [-] Crate has a serde cfg option that enables serde (C-SERDE-CFG)
      • No, but should it for a crate with no serializable types?
    • [y] Public dependencies must be stable (C-PUB-DEP)
    • [y] Crate and its dependencies have a permissive license (C-PERMISSIVE)

Tracking issue

  • BigEndian and LittleEndian example (C-EXAMPLES)
  • ByteOrder panic doc sections (C-PANIC-DOC)
  • ReadBytesExt error doc sections (C-ERROR-DOC)
  • WriteBytesExt error doc sections (C-ERROR-DOC)
  • NativeEndian and LittleEndian examples (C-EXAMPLES)
  • Add CI badges to Cargo.toml (C-CI)
  • Add "categories" to Cargo.toml (C-CARGO-HEADERS)

Notes and questions

All types are phantom types. No guidelines. It uses pub enum BigEndian {}. Is this the correct formulation? Any other phantom concerns?

These types don't implement Default, but they are uninhabitable. We have no Default guidelines, but we implement it a lot.

These phantom types implement all common traits. Why?

Likewise, should this crate do anything with serde?

What's the purpose of write_uint / write_int?

This crate sets it's "documentation" key to docs.rs. Should we put it in the guidelines? (Yes!)

Should we say anything about the readme?

Dev-deps are unstable.

This crate defines a Result typedef. Is this a best practice we should use across the board?

This crate is missing inline rustdoc links. Should we add them and make that a criteria?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment