Update readme - Githubissues

ros-tooling / topic_tools

Tools for directing, throttling, selecting, and otherwise manipulating ROS 2 topics at a meta-level.

Apache License 2.0

71 stars 33 forks source link

Update readme #82

Closed jaagut closed 11 months ago

jaagut commented 11 months ago

This PR contains few updates to the README.md file.

The most relevant changes are updates to the parameter descriptions, mainly of Throttle and Delay. They seemed to be outdated. Additionally, a list of all components including clickable references to the detailed sections and a short description has been introduced.

Other minor changes are:

Update the wiki.ros.org URL to https, previously http
Specify the language shell for commands, as recommended for Markdown
Consistent punctuation in component

jaagut commented 11 months ago

During this update, I noticed, the Delay node does not implement the lazy parameter. Is that correct and intended?

emersonknapp commented 11 months ago

During this update, I noticed, the Delay node does not implement the lazy parameter. Is that correct and intended?

Mainly this package has been a lazy port of features by folks as they are needed, so I'm guessing just nobody put in the effort to port it yet :)

jaagut commented 11 months ago

Force-pushed fixes for commit sign-offs...

MichaelOrlov commented 10 months ago

https://github.com/Mergifyio backport humble

mergify[bot] commented 10 months ago

backport humble

✅ Backports have been created

* [#89 Update readme (backport #82)](https://github.com/ros-tooling/topic_tools/pull/89) has been created for branch `humble`

MichaelOrlov commented 10 months ago

https://github.com/Mergifyio backport iron

mergify[bot] commented 10 months ago

backport iron

✅ Backports have been created

* [#90 Update readme (backport #82)](https://github.com/ros-tooling/topic_tools/pull/90) has been created for branch `iron`