Add typing and documentation for Option and OptionGroup.

Review Request #13029 — Created May 10, 2023 and submitted

Information

RBTools
release-5.x

Reviewers

Option and OptionGroup are old and didn't comply with much of our
modern standards for documentation. Now that these have been moved into
rbtools.commands.base.options, it's a good time to fix all this up,
and to prepare for upcoming changes.

This change adds missing docs and introduces typing to the whole module.

Posted with this change.

Verified that the type checkers were happy.

Summary ID
Add typing and documentation for Option and OptionGroup.
`Option` and `OptionGroup` are old and didn't comply with much of our modern standards for documentation. Now that these have been moved into `rbtools.commands.base.options`, it's a good time to fix all this up, and to prepare for upcoming changes. This change adds missing docs and introduces typing to the whole module.
f4dba9c176ea083075ea5c578909418b088365ae
Description From Last Updated

Do we really want these values?

YO YoItsMe
YO
  1. 
      
  2. rbtools/commands/base/options.py (Diff revision 1)
     
     
     
     
     

    Use comments to describe 'why', not 'what'.
    We can read 'what' in the code

  3. rbtools/commands/base/options.py (Diff revision 1)
     
     
     
     
    Do we really want these values?
  4. 
      
david
  1. Ship It!
  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-5.x (b2cf149)
Loading...