Skip to content

Naming convention: don't pun serial type names #223

@dherman

Description

@dherman

NOTE: this issue predates this project's rename to Volta.

As @mikrostew pointed out in #221, it's confusing to have foo::Bar and foo::serial::Bar types have the same name, especially with foo::serial::Bar::into_bar().

Example: notion_core::inventory::NodeIndex and notion_core::inventory::serial::NodeIndex.

Some possible naming conventions:

  • notion_core::inventory::serial::NodeIndexAst (i.e., AST)
  • notion_core::inventory::serial::NodeIndexIr (i.e., IR)
  • notion_core::inventory::serial::NodeIndexSerial
  • notion_core::inventory::serial::NodeIndexSerde
  • notion_core::inventory::serial::NodeIndexSD
  • notion_core::inventory::serial::SerialNodeIndex
  • notion_core::inventory::serial::SerdeNodeIndex
  • notion_core::inventory::serial::SDNodeIndex

I don't love any of these. Other ideas?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions