Signed-off-by: Luca Matei Pintilie <luca@lucamatei.com>
---
 To be perfectly honest, I don't fully understand the feedback on the
 previous patch in regards to documentation. So besides some minor
 rewording I think I'll need more help.

 README.md | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 429b9e3..a302624 100644
--- a/README.md
+++ b/README.md
@@ -914,8 +914,11 @@ format](https://docs.rs/chrono/0.4.19/chrono/format/strftime/index.html#specifie
 #### The `cmd` module
 
 The `cmd` module can be used to run shell commands and display their
-output. The command can be passed through the `format` configuration
-option, which will be executed by `sh -c`.
+output.
+
+The `format` configuration option can be used to run the command, which
+will get passed to `sh -c`. This means all of the variables sway has
+access to are available, such as `$SWAYSOCK`, `$HOME`.
 
 This module has no placeholders or default configuration.
 
-- 
2.45.2

swayr/patches/arch.yml: SUCCESS in 1m16s

[swayrbar(cmd): clarify cmd module documentation][0] from [Luca Matei Pintilie][1]

[0]: https://lists.sr.ht/~tsdh/public-inbox/patches/53853
[1]: luca@lucamatei.com

✓ #1275506 SUCCESS swayr/patches/arch.yml https://builds.sr.ht/~tsdh/job/1275506

Luca Matei Pintilie <luca@lucamatei.com> writes:

>  To be perfectly honest, I don't fully understand the feedback on the
>  previous patch in regards to documentation. So besides some minor
>  rewording I think I'll need more help.

Oh, I think I've not seen the sentence where mention `format`.
Apologies.  I'd still be a bit more clear, e.g., something like

    The shell command to be executed has to be provided as `format`
    value and its output is displayed in the module's space in swaybar.

Your "the command can be passed through the format configuration option"
sounds like there were other possibilities, too, which is not the case.

I'll fix that myself. :-)

Thanks again,
  Tassilo

> diff --git a/README.md b/README.md
> index 429b9e3..a302624 100644
> --- a/README.md
> +++ b/README.md
> @@ -914,8 +914,11 @@
> format](https://docs.rs/chrono/0.4.19/chrono/format/strftime/index.html#specifie
>  #### The `cmd` module
>  
>  The `cmd` module can be used to run shell commands and display their
> -output. The command can be passed through the `format` configuration
> -option, which will be executed by `sh -c`.
> +output.
> +
> +The `format` configuration option can be used to run the command, which
> +will get passed to `sh -c`. This means all of the variables sway has
> +access to are available, such as `$SWAYSOCK`, `$HOME`.
>  
>  This module has no placeholders or default configuration.

On Mon, Jul 15, 2024 at 10:42:11AM GMT, Tassilo Horn wrote:
>I'll fix that myself. :-)

Thanks! :D
--
Luca