rticommunity / rticommunity/rticonnextdds-examples
[BUG] The example's description does match example.
Open
Nobody has claimed this yet.
bug
unconfirmed
- Dominant language
- Python
- Stars
- 148
- Forks
- 153
- PR merge metrics
- No merged PRs in 30d
Description
System information
- RTI Product:
- Version:
- Operating system:
- Compiler:
- Compiler version:
- Additional information:
What is the current behavior?
The description of the group_coherent_presentation does not match the actual example.
- #1.
"In this example, the subscriber receives updates on two topics: Checkpoint Time and Checkpoint Place. "
There are actually three topics, Temperature, HeartRate and Alarm. - #2.
Example does not use the explicit method of beginning and ending the coherent set, begin_coherent_changes/end_coherent_changes, as stated in the example’s README.md, it uses the object’s construct and destructor to implicitly mark the beginning and ending ???
Steps to reproduce the issue
Expected behavior
Suggested solutions
Update Example's readme.md.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the group_coherent_presentation example's README.md and compare its description with the actual topics and coherent-change behavior. Update the text to name Temperature, HeartRate, and Alarm and accurately describe how the coherent set begins and ends; done means the README matches the example.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100