Style Guide

In order to keep the appearance of the User Guide consistent, we are recommending the following guidelines:

Headers

Text

  • No line breaks within a paragraph
  • When referring to APIs inline:
    • Wrap the string in backticks: graphlab.deploy.map_job.create
    • Use the entire namespace chain upon first mention, then just the member: create
    • Don't use parentheses, unless you include the entire signature.
    • Link an inline API to the public API docs on turi.com, at least upon first mention.

Code Snippets

  • Annotate Python code with python
  • For readability, include an empty line before the code snippet
  • line breaks within code snippets: 80 columns