This repository has been archived by the owner on Nov 13, 2023. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
wpilib: Remove CANJaguar and CANTalon stubs
These have been in our wpilib package for long enough that I think teams know that they don't exist here any more. Also turns out that the Notifier and SendableBuilder classes don't have docstrings - they don't have any JavaDoc comments upstream either. Add a test checking whether classes have docstrings anyway.
- Loading branch information
1 parent
2909a2d
commit 8c4607a
Showing
6 changed files
with
19 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,6 +6,7 @@ __pycache__ | |
htmlcov | ||
*,cover | ||
.cache | ||
.pytest_cache/ | ||
|
||
build | ||
dist | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
import inspect | ||
|
||
|
||
def test_all_classes_documented(wpilib): | ||
expected_undocumented = { | ||
wpilib: {'Notifier', 'SendableBuilder'}, | ||
wpilib.buttons: set(), | ||
wpilib.command: set(), | ||
wpilib.drive: set(), | ||
wpilib.interfaces: set(), | ||
} | ||
|
||
for package, expected_class_names in expected_undocumented.items(): | ||
actual_undocumented = set() | ||
for name, cls in inspect.getmembers(package, inspect.isclass): | ||
if not cls.__doc__: | ||
actual_undocumented.add(name) | ||
assert actual_undocumented == expected_class_names |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.