Update for example_4_keys_instances for Python

Open
#51 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
cpp, python
Domain
documentation

Research direction

Start with example_4_keys_instances and compare its Python flow with PR #50 and the linked C++ guide, focusing on step 4.5. Trace monitor_lot_state, ChocolateLotState disposal, and the later ChocolateTemperature reader steps; done means the readers, monitors, and displayed output match the guide without temperature-topic output in step 4.5.

Written by the indexing model from the issue text.

Description

While running through the Python examples, I noticed a few updates to example 4 that seem to be more inline with the C++ step-by-step flow at https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/manuals/connext_dds/getting_started/cpp11/intro_keys_instances.html#example-chocolate-factory.

Example edits in https://github.com/rticommunity/rticonnextdds-getting-started/pull/50

There may be some confusion as of step 4.5 when the user starts to learn about ChocolateLotState instance disposal. It looked like monitor_lot_state was being called for temperature topics (which aren't explored until 4.6+), leading to misleading output (e.g., "Received lot update: ").

The example changes above seem to fix this, in that the readers/monitors are hooked up correctly, the output matches the guide and they can see the instance disposal in step 4.5.

The user can still later explore the ChocolateTemperature reader support in steps 4.6+.

Dominant language
C++
Stars
32
Forks
32
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rticommunity/rticonnextdds-getting-started

All issues in rticommunity/rticonnextdds-getting-started

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.