Summary

Add typing and documentation for Option and OptionGroup.

Review Request #13029 — Created May 10, 2023 and submitted May 19, 2023, 4:14 p.m.

Information

Owner

chipx86

Repository

RBTools

Branch

release-5.x

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

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.

Testing Done

Posted with this change.

Verified that the type checkers were happy.

Commits

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

Issues

Description	From	Last Updated
Do we really want these values?	YO YoItsMe	May 11, 2023, 7:54 a.m.

flake8 passed.

JSHint passed.

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

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

rbtools/commands/base/options.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Do we really want these values?
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-5.x (b2cf149)