changed 5 years ago  
Linked with GitHub

GSoD Matplotlib Documentation Style Guide

tags: GSoD outline style guide

Expository Language

  • Terminology
    • Figure, Axes
    • Object Oriented Programming (OOP)
  • Grammar

    • Subject

      • Second person, the "User"
        • Person programming in Python with Matplotlib library
        • Refer to "User(s)" unless specifying an action

          • Users with older machines may have problems with troubleshooting.
            Powering your device off and then on again resolves most issues.

    • Tense

      • Use present simple tense as a standard
        • Avoid future tense and other modal and/or auxiliary verbs when possible

    • Voice

      • Active sentences

    • Sentence Structure

      • Short subject, verb, object
      • Coordinating conjunctions when necessary
      • Limit pronoun references and subordinating conjunctive phrases

Formatting

  • reStructuredText standards

  • Lists
    • Bulleted lists are for items that do not require sequencing

      • These are the three plots to summarize:

        • Bar
        • Scatter
        • Line
    • Numbered lists are exclusively for performing actions in specific order

Resources

Select a repo