Skip to content

Fix broken example and improve some documentation - #1735

Merged
tleonhardt merged 8 commits into
mainfrom
startup_commands-doc-updates
Aug 25, 2026
Merged

Fix broken example and improve some documentation#1735
tleonhardt merged 8 commits into
mainfrom
startup_commands-doc-updates

Conversation

@tleonhardt

@tleonhardt tleonhardt commented Aug 25, 2026

Copy link
Copy Markdown
Member

Fix broken example and improve some documentation

  • Fix broken cmd_as_argument.py example whose speak command was crashing because str has no copy method since strings are immutable in Python.
  • Update the startup_commands.md documentation to make it more discoverable what the recommended solution is for mixing commands at invocation with a custom argparse parser.
  • Update the os.md documentation to make sure it is still accurate

- Fix broken `cmd_as_argument.py` example whose `speak` command was crashing because `str` has no `copy` method since strings are immutable in Python.
- Update the startup_commands.md documentation to make it more discoverable what the recommended solution is for mixing commands at invocation with a custom argparse parser.
@tleonhardt
tleonhardt requested a review from kmvanbrunt as a code owner August 25, 2026 20:47
@codecov

codecov Bot commented Aug 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.64%. Comparing base (fd62071) to head (4bc3674).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1735      +/-   ##
==========================================
- Coverage   99.66%   99.64%   -0.02%     
==========================================
  Files          23       23              
  Lines        5937     5937              
==========================================
- Hits         5917     5916       -1     
- Misses         20       21       +1     
Flag Coverage Δ
unittests 99.64% <ø> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

Comment thread examples/cmd_as_argument.py Outdated
@kmvanbrunt
kmvanbrunt self-requested a review August 25, 2026 22:20
kmvanbrunt
kmvanbrunt previously approved these changes Aug 25, 2026
Also:
- Make some documentation more consistent with the example it was referring to
@tleonhardt
tleonhardt merged commit 5dcbcbe into main Aug 25, 2026
28 of 29 checks passed
@tleonhardt
tleonhardt deleted the startup_commands-doc-updates branch August 25, 2026 23:01
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.

2 participants