BlingCorp / bling

Utilities for the awesome window manager
https://blingcorp.github.io/bling/
MIT License
852 stars 49 forks source link

add app_launcher docs and basic options descriptions #181

Closed JimmyCozza closed 2 years ago

JimmyCozza commented 2 years ago

Refer to #130

I was actually trying to implement something exactly like this myself without knowing it already existed. Hopefully adding the docs will help someone else find it on the bling website.

Couple things in this documentation.

1) I wasn't sure the proper way to give a description of every option, some I left blank because I don't understand what the options do. (save_history, the commands options, and the rubato option) 2) I noticed a typo on the shrink_width option, but I didn't want to fix it without running it by your team first. The correct move would be to rename from shirnk_width to shrink_width but I don't know the downstream effects or how you normally disseminate breaking changes like that, so I left it as shirnk_width and documented it as such. Should I add a more clear note in these docs letting end users know that it's not a typo in the docs, rather the real option name? 3) Do you want more images to demonstrate the options? I wasn't sure so I just used the image @JavaCafe01 posted a little bit ago in one of the PRs (https://github.com/BlingCorp/bling/pull/103#issuecomment-960128253).

Let me know what I can improve on this, and thank you all so much for bling.

Nooo37 commented 2 years ago

Very cool that you did that, thank you

don't understand what the options do. (save_history, the commands options, and the rubato option)

Not a huge user of the module myself. My guesses are that Rubato is probably there to make the launcher "fly" into the screen and should be a table { x = rubato_animation_x, y = rubato_animation_y }. search_commands should be a boolean that determines whether the app launcher should not only match the name of the app but can also match the commandline command with which it would start (https://lazka.github.io/pgi-docs/Gio-2.0/interfaces/AppInfo.html#Gio.AppInfo.get_commandline). So skip_commands would be the same as skip_names but for commandline options (eg maybe something like skip all that have a "--whatever" flag). Maybe @Kasper24 or @JavaCafe01 can provide more insights?

rename from shirnk_width to shrink_width but I don't know the downstream effects or how you normally disseminate breaking changes

I would say, just rename the option. We don't do releases so there is no good way to fix something like that

Do you want more images to demonstrate the options?

One image is enough, it's just there so people can get an idea. We handle it like that in other modules too :+1:

JimmyCozza commented 2 years ago

@Kasper24 Question for you about how you intended for the skip_commands option to work.

Was it intended to allow me to skip some granular levels of commandline command like Noo037 mentioned above?

Let's say I want to have some Thunar commands show in the list, but not all of them. I normally have

Say I don't want the Bulk Rename option to show, should I be able to pass in --bulk-rename %F to skip that app? or Should I pass in thunar --bulk-rename %Fto skip it?

Right now, neither of those is what actually happens for me, so maybe I still don't understand the intent.

Nooo37 commented 2 years ago

Kasper seems to be awol for the time being. Thank you for your contribution of making his work usable for other people too, very much appreciated