scenario
latest

Contents:

  • Purpose of the scenario testing framework
  • Installation
  • Quick start
  • Advanced usage
  • Development
    • Development environment
    • Design
    • Coding rules
      • Files
      • Git
      • Python coding
      • Documentation
    • Guidelines
scenario
  • Development
  • Coding rules
  • Edit on GitHub

Coding rules¶

A few coding rules are defined for the project.

  • Files
    • File permissions
    • Encodings
  • Git
    • Branching strategy
    • Commit messages
  • Python coding
    • Strings
    • Namings
    • Presentation
    • Packages
    • Static & class methods
    • Typings
    • Imports
    • Python compatibility
  • Documentation
    • Docstrings
    • Admonitions: notes, warnings…
    • ReStructured Text indentation
    • Domains
    • Cross references
    • Module attributes
    • Property return type hint
Previous Next

© Copyright 2020-2023 Alexis Royer <https://github.com/alxroyer/scenario>. Revision 7bb93776.

Built with Sphinx using a theme provided by Read the Docs.