brotzeit / rustic

Rust development environment for Emacs
Apache License 2.0
723 stars 101 forks source link

Confusion on the behavior of rustic-cargo-run, rustic-cargo-plain-run and rustic-comint-run #517

Open hi563145 opened 1 year ago

hi563145 commented 1 year ago

Confusion

rustic-cargo-run and rustic-cargo-comint-run

The documentation string says that when arg is nil, the value of arg would be used and stored in rustic-run-arguments. However, the actual behavior is getting the value from mini buffer and storing it to rustic-run-arguments (rustic-run-comint-arguments for rustic-cargo-comint-run).

rustic-cargo-plain-run

The function does what the documentation says. However, if the arg is nil it still reads the arguments from the mini buffer.

Proposal

All rustic-cargo-run, rustic-cargo-plain-run and rustic-comint-run:

Additional Features

psibi commented 1 year ago

The documentation string likely needs to be improved. Does the documentation for the run commands on the README.md help in clarifying things: https://github.com/brotzeit/rustic#run ?

hi563145 commented 1 year ago

Not really as the reason why I am confused is because I wanted to run in comint mode with specific command line argument (I have multiple binary crates). This lead me to look into the source code and notice the behavior is kinda inconsistent. I am curious about what you think about my proposal as I am looking into learning some elisp and might be able to contribute.