update "self-explanatory" descriptions (#128)

I don't see any reason to say "self-explanatory" instead of providing a description.

Co-authored-by: uShldGetCeleste <68669265+uShldGetCeleste@users.noreply.github.com>
This commit is contained in:
qupufu 2023-02-15 01:56:51 -07:00 committed by GitHub
parent bdc56f2393
commit 323d81d9ea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -46,12 +46,12 @@ SHIFT CAPS CTRL/CONTROL ALT MOD2 MOD3 SUPER/WIN/LOGO/MOD4 MOD5
| name | description | type | default | | name | description | type | default |
|---|---|---|---| |---|---|---|---|
| sensitivity | mouse sensitivity (legacy, may cause bugs if not 1, prefer `input:sensitivity`) | float | 1.0 | | sensitivity | mouse sensitivity (legacy, may cause bugs if not 1, prefer `input:sensitivity`) | float | 1.0 |
| border_size | self-explanatory | int | 1 | | border_size | size of the border around windows | int | 1 |
| no_border_on_floating | disable borders for floating windows | bool | false | | no_border_on_floating | disable borders for floating windows | bool | false |
| gaps_in | gaps between windows | int | 5 | | gaps_in | gaps between windows | int | 5 |
| gaps_out | gaps between windows and monitor edges | int | 20 | | gaps_out | gaps between windows and monitor edges | int | 20 |
| col.inactive_border | self-explanatory | gradient | 0xffffffff | | col.inactive_border | border color for inactive windows | gradient | 0xffffffff |
| col.active_border | self-explanatory | gradient | 0xff444444 | | col.active_border | border color for the active window | gradient | 0xff444444 |
| cursor_inactive_timeout | in seconds, after how many seconds of cursor's inactivity to hide it. Set to `0` for never. | int | 0 | | cursor_inactive_timeout | in seconds, after how many seconds of cursor's inactivity to hide it. Set to `0` for never. | int | 0 |
| layout | which layout to use. (Available: `dwindle`, `master`) | str | dwindle | | layout | which layout to use. (Available: `dwindle`, `master`) | str | dwindle |
| no_cursor_warps | if true, will not warp the cursor in many cases (focusing, keybinds, etc) | bool | false | | no_cursor_warps | if true, will not warp the cursor in many cases (focusing, keybinds, etc) | bool | false |
@ -67,9 +67,9 @@ Prefer using `input:sensitivity` over `general:sensitivity` to avoid bugs, espec
|---|---|---|---| |---|---|---|---|
| rounding | rounded corners' radius (in layout px) | int | 0 | | rounding | rounded corners' radius (in layout px) | int | 0 |
| multisample_edges | enable antialiasing (no-jaggies) for rounded corners | bool | true | | multisample_edges | enable antialiasing (no-jaggies) for rounded corners | bool | true |
| active_opacity | self-explanatory, only for windows. (0.0 - 1.0) | float | 1.0 | | active_opacity | opacity of active windows. (0.0 - 1.0) | float | 1.0 |
| inactive_opacity | self-explanatory, only for windows. (0.0 - 1.0) | float | 1.0 | | inactive_opacity | opacity of inactive windows. (0.0 - 1.0) | float | 1.0 |
| fullscreen_opacity | self-explanatory, only for windows. (0.0 - 1.0) | float | 1.0 | | fullscreen_opacity | opacity of fullscreen windows. (0.0 - 1.0) | float | 1.0 |
| blur | enable kawase window background blur | bool | true | | blur | enable kawase window background blur | bool | true |
| blur_size | blur size (distance) | int | 8 | | blur_size | blur size (distance) | int | 8 |
| blur_passes | the amount of passes to perform | int | 1 | | blur_passes | the amount of passes to perform | int | 1 |
@ -261,7 +261,7 @@ Only for developers.
|---|---|---|---| |---|---|---|---|
| overlay | print the debug performance overlay. Disable VFR for accurate results. | bool | false | | overlay | print the debug performance overlay. Disable VFR for accurate results. | bool | false |
| damage_blink | (epilepsy warning!) flash areas updated with damage tracking | bool | false | | damage_blink | (epilepsy warning!) flash areas updated with damage tracking | bool | false |
| disable_logs | self-explanatory | bool | false | | disable_logs | disable logging | bool | false |
| disable_time | disables time logging | bool | true | | disable_time | disables time logging | bool | true |
| damage_tracking | redraw only the needed bits of the display. Do **not** change. (default: full - 2) monitor - 1, none - 0 | int | 2 | | damage_tracking | redraw only the needed bits of the display. Do **not** change. (default: full - 2) monitor - 1, none - 0 | int | 2 |