Skip to content

Style Guide/Consistent style #64

Description

@Robadob

Items raised whilst working through @JostMigenda's additions.

  • Title case
  • long numbers in code (e.g. break them up with _)
  • quote style (e.g. regular vs typographic quotes)
  • x vs multiplication symbol
  • referring to functions (from code examples) in the text (e.g. foo() rather than foo)
  • avoid first person
  • Prefer to avoid raw links, (e.g. link some descriptive text instead, carpentries CI will nag if the text is just here)

Not sure what else would be relevant.

Then we'd obviously need to review the site to check they're implemented.

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