Skip to content

Update docstring of command type#224

Open
Miauwkeru wants to merge 1 commit intomainfrom
update-command-type-docstring
Open

Update docstring of command type#224
Miauwkeru wants to merge 1 commit intomainfrom
update-command-type-docstring

Conversation

@Miauwkeru
Copy link
Copy Markdown
Contributor

Noticed from #220 that the docstring of the command type didn't
represent the correct output anymore since we now also split the windows
arguments.

Noticed from #220 that the docstring of the command type didn't
represent the correct output anymore since we now also split the windows
arguments.
@Miauwkeru Miauwkeru requested a review from yunzheng April 2, 2026 13:17
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 2, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.24%. Comparing base (5093cf6) to head (82a5491).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #224   +/-   ##
=======================================
  Coverage   84.24%   84.24%           
=======================================
  Files          35       35           
  Lines        3746     3746           
=======================================
  Hits         3156     3156           
  Misses        590      590           
Flag Coverage Δ
unittests 84.24% <ø> (ø)

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

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Member

@yunzheng yunzheng left a comment

Choose a reason for hiding this comment

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

Actually the code block doesn't really make sense to me. The old one didn't really either now that I look back at it.

'c:\\windows\\malware.exe /info'                      ->   windows_path('c:\\windows\\malware.exe) ('/info',)
'/usr/bin/env bash'                                   ->   posix_path('/usr/bin/env') ('bash',)

# In this situation, the executable path needs to be quoted.
'c:\\user\\John Doe\\malware.exe /all /the /things'   ->   windows_path('c:\\user\\John')                                                                  ('Doe\\malware.exe, '/all', '/the', /things')

wouldn't it be better to show how it works with a inline doctest?

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