Skip to content

Hardware libraries style guide #64

@nkrkv

Description

@nkrkv

As mentioned in #63 (comment):

We have a few conventions that are scattered through the docs or even unwritten.
For example:

We have a few conventions that are scattered through the docs or even unwritten.
For example:

  • any nodes that create a new type to work with hardware should be named as xxx-device
  • node that initialises hardware module should be named init
  • names of any nodes which do instructions "what to do" in imperative style must begin with a verb (init, read-byte, pair-tag, write-line, etc)
  • nodes that "unfold" complex types into more primitive ones are named unpack-xxx
  • example patches are named example-xxx
    (and probably a few others that I forgot to mention)

It will be cool to summarize these in a single guide article.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions