Communications Style Guide

Below is a style guide for any textual communication between users of Plottable.

Type Capitalization

• When referring to a class/type, use the capitalized version of the actual name.
  • For example, "Component" instead of "component" and "Plots.Bar" instead of "bar plot".

Functions need Parentheses

• When referring to methods, please put parentheses after the name.
  • For example, "anchor()" instead of "anchor" and "computeLayout()" instead of "compute layout".

Code Formatting

• When writing down code, please use some sort of formatting tool so that the code can be more easily read.
  • For example, Github allows the usage of "```typescript" in order to achieve formatting and syntax highlighting in Typescript.

Markdown issues

• Always include a space after a # for headers. The wiki accepts ##Header but the releases page only accepts ## Header