Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #82

Merged
merged 6 commits into from
Oct 3, 2023
Merged

Update readme #82

merged 6 commits into from
Oct 3, 2023

Conversation

jaagut
Copy link
Contributor

@jaagut jaagut commented Sep 25, 2023

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 jaagut requested a review from a team as a code owner September 25, 2023 14:06
@jaagut
Copy link
Contributor Author

jaagut commented Sep 25, 2023

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

Copy link
Contributor

@emersonknapp emersonknapp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for helping improve documentation

@emersonknapp
Copy link
Contributor

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 :)

Jan Gutsche added 6 commits October 2, 2023 20:09
Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>
Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>
Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>
Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>
Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>
Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>
@jaagut
Copy link
Contributor Author

jaagut commented Oct 2, 2023

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

@MichaelOrlov MichaelOrlov enabled auto-merge (squash) October 3, 2023 15:25
@MichaelOrlov MichaelOrlov merged commit f73df4a into ros-tooling:main Oct 3, 2023
11 checks passed
@jaagut jaagut deleted the update_readme branch October 3, 2023 16:38
@MichaelOrlov
Copy link
Member

https://github.com/Mergifyio backport humble

Copy link

mergify bot commented Nov 17, 2023

backport humble

✅ Backports have been created

@MichaelOrlov
Copy link
Member

https://github.com/Mergifyio backport iron

Copy link

mergify bot commented Nov 17, 2023

backport iron

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Nov 17, 2023
* Readme: add overview of components

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

* Readme: Update wiki.ros.org URL to https

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

* Readme: specify shell language for commands

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

* Readme: Consistent punctuation

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

* Readme: Update parameter description

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

* Readme: Clearify mux initial_topic param

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

---------

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>
Co-authored-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>
(cherry picked from commit f73df4a)
mergify bot pushed a commit that referenced this pull request Nov 17, 2023
* Readme: add overview of components

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

* Readme: Update wiki.ros.org URL to https

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

* Readme: specify shell language for commands

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

* Readme: Consistent punctuation

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

* Readme: Update parameter description

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

* Readme: Clearify mux initial_topic param

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

---------

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>
Co-authored-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>
(cherry picked from commit f73df4a)
MichaelOrlov pushed a commit that referenced this pull request Nov 17, 2023
* Readme: add overview of components

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

* Readme: Update wiki.ros.org URL to https

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

* Readme: specify shell language for commands

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

* Readme: Consistent punctuation

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

* Readme: Update parameter description

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

* Readme: Clearify mux initial_topic param

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

---------

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>
Co-authored-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>
(cherry picked from commit f73df4a)

Co-authored-by: Jan Gutsche <34797331+jaagut@users.noreply.github.com>
MichaelOrlov pushed a commit that referenced this pull request Nov 17, 2023
* Readme: add overview of components

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

* Readme: Update wiki.ros.org URL to https

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

* Readme: specify shell language for commands

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

* Readme: Consistent punctuation

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

* Readme: Update parameter description

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

* Readme: Clearify mux initial_topic param

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>

---------

Signed-off-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>
Co-authored-by: Jan Gutsche <githubrostoolingtopictools@jaagut.de>
(cherry picked from commit f73df4a)

Co-authored-by: Jan Gutsche <34797331+jaagut@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants