Skip to content

Commit 7826b98

Browse files
author
Claire Wang
authored
update README entry point examples (#329)
Signed-off-by: claireyywang <[email protected]>
1 parent d7d96c5 commit 7826b98

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

ros2doctor/README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,19 @@ Run `ros2 doctor -r/--report` to see details of checks.
1515

1616
## Add New Checks
1717

18-
To add your own checks or information to report, use [Python entry points](https://setuptools.readthedocs.io/en/latest/pkg_resources.html#entry-points) to add modules to `setup.py`. See example below:
18+
To add your own checks or information to report, use [Python entry points](https://setuptools.readthedocs.io/en/latest/pkg_resources.html#entry-points) to add modules to `setup.py`.
19+
See example below:
1920

2021
```python
2122
entry_points={
2223
'ros2doctor.checks': [
23-
'check_platform = ros2doctor.api.platform:check_platform',
24+
'PlatformCheck = ros2doctor.api.platform:PlatformCheck',
25+
'NetworkCheck = ros2doctor.api.network:NetworkCheck',
2426
],
2527
'ros2doctor.report': [
26-
'report_platform = ros2doctor.api.platform:print_platform_info',
27-
'report_ros_distro = ros2doctor.api.platform:print_ros2_info',
28+
'PlatformReport = ros2doctor.api.platform:PlatformReport',
29+
'RosdistroReport = ros2doctor.api.platform:RosdistroReport',
30+
'NetworkReport = ros2doctor.api.network:NetworkReport',
2831
],
2932
}
3033
```

0 commit comments

Comments
 (0)