Inconsistencies between `local()` and `local_resource()`
Open
Nobody has claimed this yet.
bug
good first issue
Windows
- Dominant language
- Go
- Stars
- 10.1k
- Forks
- 413
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 6
Description
For windows-compatibility, the local() function has a command_bat argument where you can supply the windows-equivalent of your command.
The very closely related function local_resource() also has the same functionality, BUT the argument is called cmd_bat instead.
This inconsistency is unexpected and, at times, frustrating.
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
Start by locating the definitions and tests for the local() and local_resource() entry points, then compare how their Windows command arguments are exposed. The work is done when the argument naming is consistent between both functions and the relevant behavior remains covered by tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- devtools
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100