Skip to content

Completely optional: adjust naming to line up with Rust API guidelines? #44

@TheLostLambda

Description

@TheLostLambda

This one is only if you fancy it, but https://rust-lang.github.io/api-guidelines/naming.html#casing-conforms-to-rfc-430-c-case says:

In UpperCamelCase, acronyms and contractions of compound words count as one word: use Uuid rather than UUID, Usize rather than USize or Stdin rather than StdIn. In snake_case, acronyms and contractions are lower-cased: is_xid_start.

I think there are a number of places where acronyms are all-uppercase like Tolerance::PPM and the mixed casing of MzML, and MZReader, but these are just style tweaks we can bundle in with any other breaking changes that may happen in the future.

More generally, that https://rust-lang.github.io/api-guidelines/checklist.html is just a lovely reference I'm always looking back at and take every opportunity to share!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions