Best Practices Example

Examples of docs taken from some of our better code and from some from other’s code that we’ve learned the most from.

Last is an example of Sphinx auto-doc functions used in the Python modules. There are some great starter guides out there.

Contents:

• Example Executive Summary- Climate Program Precip
  • How to use this example
  • Summary
  • Sizes of orifice, tank, and instrument
  • Tank gauge accuracy
  • Replacement sensor
• Repository Settings: Collaboration, Merging, and Pull Requests
  • Collaboration Styles
    • Collaborating with yourself
    • Collaborating with teammates (branch merging)
    • Collaborating with everyone
  • Structuring collaboration with permissions
    • Private repositories
    • Public repositories
    • Branch permissions
  • Pull Requests
• Clean Security Issues from Git History
  • Best Practice
  • Ooops, No One Noticed Until Now
  • git filter-repo
    • Windows Install
    • Cleaning Your Repo
    • Correcting the Target Lines (regex)
  • Applying fixes to remote
• Keeping Paths and Credentials Out of Git History
• Handling App Passwords
• Issues with Python Paths
  • Extra Jupyter Note
• Python Module
  • hobo_qaqc Module
  • file_manager Module

Contents

• Best Practices Example
  • Indices and tables

Indices and tables

• Index
• Search Page