Conventions

The following topics details the conventions used in the project.

Scripts naming

Scripts have short, all-lowercase names.

A script may be public, non-public or a hook.

  • Public scripts have all-lowercase names (e.g. lappdeploy).

  • Non-public scripts have all lowercase names with a leading underscore (e.g. _log2mail).

  • Hook scripts have all lowercase names with a double leading and trailing underscore (e.g. __init__).

Furthermore, this set of rules is inspired from the naming convention defining in PEP 8#package-and-module-names.

Usage description syntax

Built-in usage help and usages topics comply with the Windows command line syntax reminded below.

  • angle brackets for required parameters: ping <hostname>

  • square brackets for optional parameters: mkdir [-p] <dirname>

  • ellipses for repeated items: cp <source1> [source2...] <dest>

  • vertical bars for choice of items: netstat {-t|-u}

Furthermore, usage topics comply the rules defining in ‘Python Developer’s Guide’ PEP 257#multi-line-docstrings, by documenting the script’s function and command line syntax, environment variables, and files.