Update help documentation to pass option in recommended format
- Dominant language
- C#
- Stars
- 11.5k
- Forks
- 960
- PR merge metrics
- No merged PRs in 30d
Description
### Checklist
- [x] I have verified this is the correct repository for opening this issue.
- [x] I have verified no other issues exist related to my request.
### Is Your Feature Request Related To A Problem? Please describe.
_No response_
### Describe The Solution. Why is it needed?
We should look over all of the help documentation and update every mention of how options have been passed to use our recommended practices.
Currently our help documentation uses the format `-- `, but we are recommended that users pass options with the format `--="''"`, we should update our help documentation to make use of this formatting.
### Additional Context
_No response_
### Related Issues
_No response_
Contributor guide
Research direction
Search the repository's help documentation for every occurrence of the current `-- ` option format. Review each match in context, update the documentation to use the recommended `--="''"` format, and verify that no old examples remain.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100