Clean up docs grammar and consistency (#196)

This commit is contained in:
Stardust-kyun 2023-01-23 13:20:23 -05:00 committed by GitHub
parent d670537bea
commit af90ae42a9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 9 additions and 9 deletions

View File

@ -4,7 +4,7 @@
[AwesomeWM](https://awesomewm.org/) is literally what it stands for, an awesome window manager. [AwesomeWM](https://awesomewm.org/) is literally what it stands for, an awesome window manager.
Its unique selling point has always been the widget system, which allows for fancy buttons, sliders, bars, dashboards and anything you can imagine. But that feature can be a curse. Most modules focus on the widget side of things which leave the actual window managing part of AwesomeWM underdeveloped compared to, for example, [xmonad](https://xmonad.org/) even though it's probably just as powerfull in that area. Its unique selling point has always been the widget system, which allows for fancy buttons, sliders, bars, dashboards and anything you can imagine. But that feature can be a curse. Most modules focus on the widget side of things which leave the actual window managing part of AwesomeWM underdeveloped compared to, for example, [xmonad](https://xmonad.org/) even though it's probably just as powerful in that area.
This project focuses on that problem - adding new layouts and modules that make use of the widget system, but primarily focus on the new window managing features. This project focuses on that problem - adding new layouts and modules that make use of the widget system, but primarily focus on the new window managing features.

View File

@ -2,7 +2,7 @@
Choose layouts from the list below and add them to to your `awful.layouts` list in your `rc.lua`. Choose layouts from the list below and add them to to your `awful.layouts` list in your `rc.lua`.
Everyone of them supports multiple master clients and master width factor making them easy to use. Every one of them supports multiple master clients and master width factor making them easy to use.
The mstab layout uses the tab theme from the tabbed module. The mstab layout uses the tab theme from the tabbed module.

View File

@ -61,7 +61,7 @@ term_scratch:turn_on() -- turns the scratchpads visibility on
term_scratch:turn_off() -- turns the scratchpads visibility off term_scratch:turn_off() -- turns the scratchpads visibility off
``` ```
You can also connect to signals as you are used to for further customization. For example like that: You can also connect to signals for further customization. For example:
```lua ```lua
term_scratch:connect_signal("turn_on", function(c) naughty.notify({title = "Turned on!"}) end) term_scratch:connect_signal("turn_on", function(c) naughty.notify({title = "Turned on!"}) end)

View File

@ -51,7 +51,7 @@ Modern theme:
*screenshot by [JavaCafe01](https://github.com/JavaCafe01)* *screenshot by [JavaCafe01](https://github.com/JavaCafe01)*
### Signals ### Signals
The tabbed module emits a few signals for the purpose of integration, The tabbed module emits a few signals for the purpose of integration:
```lua ```lua
-- bling::tabbed::update -- triggered whenever a tabbed object is updated -- bling::tabbed::update -- triggered whenever a tabbed object is updated
-- tabobj -- the object that caused the update -- tabobj -- the object that caused the update

View File

@ -62,9 +62,9 @@ bling.module.wallpaper.setup {
The setup function will do 2 things: call the set-function when awesome requests a wallpaper, and manage a timer to call `set_function` periodically. The setup function will do 2 things: call the set-function when awesome requests a wallpaper, and manage a timer to call `set_function` periodically.
Its argument is a args table that is passed to ohter functions (setters and wallpaper functions), so you define everything with setup. Its argument is an args table that is passed to other functions (setters and wallpaper functions), so you define everything with setup.
The `set_function` is a function called every times a wallpaper is needed. The `set_function` is a function called every time a wallpaper is needed.
The module provides some setters: The module provides some setters:

View File

@ -1,6 +1,6 @@
## 🎨 App Launcher <!-- {docsify-ignore} --> ## 🎨 App Launcher <!-- {docsify-ignore} -->
A popup application launcher similar to Rofi A popup application launcher similar to Rofi.
![](https://user-images.githubusercontent.com/33443763/140196352-07e444fe-cccd-45ad-93fa-5705f09e516b.png) ![](https://user-images.githubusercontent.com/33443763/140196352-07e444fe-cccd-45ad-93fa-5705f09e516b.png)

View File

@ -108,7 +108,7 @@ awful.widget.tasklist({
}) })
``` ```
If you need to do something else, it can be used like so If you need to do something else, it can be used like so:
```lua ```lua
update_callback = function(self, client, index, clients) update_callback = function(self, client, index, clients)
require("bling.widget.tabbed_misc").custom_tasklist(self, client, index, clients) require("bling.widget.tabbed_misc").custom_tasklist(self, client, index, clients)

View File

@ -26,7 +26,7 @@ bling.widget.task_preview.enable {
} }
``` ```
To allow for more customization, there is also a `widget_structure` property (as seen in some default awesome widgets) which is optional. An example is as follows - To allow for more customization, there is also a `widget_structure` property (as seen in some default awesome widgets) which is optional. An example is as follows:
```lua ```lua
bling.widget.task_preview.enable { bling.widget.task_preview.enable {
x = 20, -- The x-coord of the popup x = 20, -- The x-coord of the popup