Skip to content

Commit 30f32ef

Browse files
committed
fix: fix formatting in documents
1 parent 61c58dc commit 30f32ef

7 files changed

Lines changed: 51 additions & 48 deletions

File tree

.github/dependabot.yml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33

44
version: 2
55
updates:
6-
# Maintain dependencies for GitHub Actions
7-
- package-ecosystem: "github-actions"
8-
directory: "/"
9-
schedule:
10-
interval: "weekly"
6+
# Maintain dependencies for GitHub Actions
7+
- package-ecosystem: "github-actions"
8+
directory: "/"
9+
schedule:
10+
interval: "weekly"
1111

12-
# Rust projects
13-
- package-ecosystem: "cargo"
14-
directory: "/"
15-
schedule:
16-
interval: "weekly"
12+
# Rust projects
13+
- package-ecosystem: "cargo"
14+
directory: "/"
15+
schedule:
16+
interval: "weekly"

CHANGELOG.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ Changes on `main` since **[1.4.6](https://github.com/waycrate/wayshot/releases/t
5252
#### Breaking Changes
5353

5454
- **wayshot** and **waymirror-egl** are **GPL-3.0**; **libwayshot** stays **BSD-2-Clause** ([#311](https://github.com/waycrate/wayshot/pull/311), [@Gigas002](https://github.com/Gigas002)).
55-
- **Migration:** confirm licensing and redistribution obligations for anything you ship or vendor; see `LICENSE-GPL` and `LICENSE-BSD`.
55+
- **Migration:** confirm licensing and redistribution obligations for anything you ship or vendor; see `LICENSE-GPL` and `LICENSE-BSD`.
5656
- **`-g` / `--geometry`** accepts an optional **geometry string** (e.g. from slurp / `waysip -d`); a token immediately after **`-g`** is now treated as that string, not the output file ([#333](https://github.com/waycrate/wayshot/pull/333), [@Gigas002](https://github.com/Gigas002)).
57-
- **Migration:** if you relied on **`wayshot -g FILE`** (output path right after **`-g`**), use **`wayshot FILE -g`** instead. Invocations like **`wayshot -g --clipboard`** are unchanged.
57+
- **Migration:** if you relied on **`wayshot -g FILE`** (output path right after **`-g`**), use **`wayshot FILE -g`** instead. Invocations like **`wayshot -g --clipboard`** are unchanged.
5858

5959
## [1.4.6] - 2026-03-09
6060

@@ -125,11 +125,11 @@ Changes on `main` since **[1.4.6](https://github.com/waycrate/wayshot/releases/t
125125
#### Breaking Changes
126126

127127
- Many capture / screenshot entry points now take arguments in a fixed order: **target → options → cursor → optional region** ([#270](https://github.com/waycrate/wayshot/pull/270), [@Decodetalkers](https://github.com/Decodetalkers)).
128-
- **Migration:** update call sites to the new parameter order; consult current `libwayshot` method signatures.
128+
- **Migration:** update call sites to the new parameter order; consult current `libwayshot` method signatures.
129129
- **`WayshotTarget`** / foreign toplevel handles must be chosen from targets libwayshot already knows about (not an arbitrary foreign id alone) ([#270](https://github.com/waycrate/wayshot/pull/270), [@Decodetalkers](https://github.com/Decodetalkers)).
130-
- **Migration:** enumerate toplevels via libwayshot, then select the matching target.
130+
- **Migration:** enumerate toplevels via libwayshot, then select the matching target.
131131
- **`try_init_buf`** no longer returns the initialized buffer from the same return channel; use `()` / `Error` only ([#270](https://github.com/waycrate/wayshot/pull/270), [@Decodetalkers](https://github.com/Decodetalkers)).
132-
- **Migration:** follow the updated init + capture flow in the docs / examples.
132+
- **Migration:** follow the updated init + capture flow in the docs / examples.
133133

134134
### wayshot
135135

@@ -179,7 +179,7 @@ Changes on `main` since **[1.4.6](https://github.com/waycrate/wayshot/releases/t
179179
#### Breaking Changes
180180

181181
- `Size` is now generic (`Size<T = u32>`) ([`279896a`](https://github.com/waycrate/wayshot/commit/279896a060adaa385a8c6b59a38864468c2a18d8), [@Decodetalkers](https://github.com/Decodetalkers)).
182-
- **Migration:** specify `Size<u32>` (or another `T`) where type inference no longer resolves, and update patterns that assumed a non-generic `Size`.
182+
- **Migration:** specify `Size<u32>` (or another `T`) where type inference no longer resolves, and update patterns that assumed a non-generic `Size`.
183183

184184
[1.4.1]: https://github.com/waycrate/wayshot/compare/1.4.0...v1.4.1
185185

@@ -216,9 +216,9 @@ Changes on `main` since **[1.4.6](https://github.com/waycrate/wayshot/releases/t
216216
#### Breaking Changes
217217

218218
- legacy `screenshot` APIs deprecated or restricted where **ext-image-copy** differs from **zwlr-screencopy**; use **`screenshot_freeze`** instead ([`c0065d3`](https://github.com/waycrate/wayshot/commit/c0065d37547bc18729d052a6e89628c34c3d3097), [`21cfa0f`](https://github.com/waycrate/wayshot/commit/21cfa0f36c7c3b7ce6ba4998f0e9ae6808d93ec0), [@Decodetalkers](https://github.com/Decodetalkers)). Some paths (e.g. color picker) keep the old API on purpose ([`73df58e`](https://github.com/waycrate/wayshot/commit/73df58ef030c97e89d2b77f0a3788ef26ef00b83)).
219-
- **Migration:** move affected call sites to **`screenshot_freeze`**; re-read deprecation on the symbols you use.
219+
- **Migration:** move affected call sites to **`screenshot_freeze`**; re-read deprecation on the symbols you use.
220220
- `FrameGuard` carries side / transform metadata ([`1af8f788`](https://github.com/waycrate/wayshot/commit/1af8f78840c3f20b74e0225a747505f8a4eaf73f), [@Decodetalkers](https://github.com/Decodetalkers)).
221-
- **Migration:** update construction and pattern matches to include the new fields.
221+
- **Migration:** update construction and pattern matches to include the new fields.
222222

223223
### wayshot
224224

@@ -240,15 +240,14 @@ Changes on `main` since **[1.4.6](https://github.com/waycrate/wayshot/releases/t
240240
#### Breaking Changes
241241

242242
- colored output, help text, and option renames (“friendly CLI”) ([#134](https://github.com/waycrate/wayshot/pull/134), [@Gigas002](https://github.com/Gigas002)).
243-
- **Migration:** update scripts and wrappers that parse `--help`, grep for old long option names, or assume plain stderr; use the current kebab-case flags and check `wayshot --help` for aliases where the old spellings still work.
243+
- **Migration:** update scripts and wrappers that parse `--help`, grep for old long option names, or assume plain stderr; use the current kebab-case flags and check `wayshot --help` for aliases where the old spellings still work.
244244
- region selection uses **libwaysip** in-process instead of spawning **slurp** ([#152](https://github.com/waycrate/wayshot/pull/152), [`586ee25`](https://github.com/waycrate/wayshot/commit/586ee258f824a6fc71d796272ffa9635236cc226), [@Decodetalkers](https://github.com/Decodetalkers)).
245-
- **Migration:** drop expectations that `slurp` is run externally or that `-s` forwards arguments to slurp; adjust automation that wrapped or mocked slurp; rely on wayshot’s built-in selector (and libwaysip behavior) only.
245+
- **Migration:** drop expectations that `slurp` is run externally or that `-s` forwards arguments to slurp; adjust automation that wrapped or mocked slurp; rely on wayshot’s built-in selector (and libwaysip behavior) only.
246246

247247
#### Fixed
248248

249249
- `-` / stdout no longer creates an empty file in cwd ([`a5575b6`](https://github.com/waycrate/wayshot/commit/a5575b6c9c3f12426309ac0309ce6f012cf4d729), [@uncomfyhalomacro](https://github.com/uncomfyhalomacro)).
250250
- embedded region selection on adjacent outputs ([#199](https://github.com/waycrate/wayshot/pull/199), [@Pestdoktor](https://github.com/Pestdoktor)).
251251

252252
[1.4.0]: https://github.com/waycrate/wayshot/compare/1.3.1...v1.4.0
253-
254253
[Unreleased]: https://github.com/waycrate/wayshot/compare/v1.4.6...HEAD

CODE_OF_CONDUCT.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
1717
Examples of behavior that contributes to a positive environment for our
1818
community include:
1919

20-
* Demonstrating empathy and kindness toward other people
21-
* Being respectful of differing opinions, viewpoints, and experiences
22-
* Giving and gracefully accepting constructive feedback
23-
* Accepting responsibility and apologizing to those affected by our mistakes,
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
2424
and learning from the experience
25-
* Focusing on what is best not just for us as individuals, but for the
25+
- Focusing on what is best not just for us as individuals, but for the
2626
overall community
2727

2828
Examples of unacceptable behavior include:
2929

30-
* The use of sexualized language or imagery, and sexual attention or
30+
- The use of sexualized language or imagery, and sexual attention or
3131
advances of any kind
32-
* Trolling, insulting or derogatory comments, and personal or political attacks
33-
* Public or private harassment
34-
* Publishing others' private information, such as a physical or email
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
3535
address, without their explicit permission
36-
* Other conduct which could reasonably be considered inappropriate in a
36+
- Other conduct which could reasonably be considered inappropriate in a
3737
professional setting
3838

3939
## Enforcement Responsibilities
@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
106106
### 4. Permanent Ban
107107

108108
**Community Impact**: Demonstrating a pattern of violation of community
109-
standards, including sustained inappropriate behavior, harassment of an
109+
standards, including sustained inappropriate behavior, harassment of an
110110
individual, or aggression toward or disparagement of classes of individuals.
111111

112112
**Consequence**: A permanent ban from any sort of public interaction within

CONTRIBUTING.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
11
# Contributing to wayshot
2+
23
1. Fork the repo and create your branch from `main`.
34
1. Create your changes.
45
1. Test your changes in all possible permutations and combinations.
56
1. Send a pull request upstream!
67

78
## Any contributions you make will be under the BSD-2-Clause Software License
9+
810
In short, when you submit code changes, your submissions are understood to be under the same BSD-2-Clause License that covers the project. Feel free to contact the maintainers if that's a concern.
911

1012
## Use a Consistent Coding Style
11-
* You can run `make check` for style unification.
13+
14+
- You can run `make check` for style unification.
1215

1316
## Proper Commit Messages
17+
1418
Make sure to write proper commit messages with `conventional commits` syntax.
1519

1620
## License
21+
1722
By contributing, you agree that your contributions will be licensed under its BSD-2-Clause License.

LICENSE-BSD

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,3 @@ LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
2020
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2121
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
2222
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23-

LICENSE-GPL

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -671,4 +671,4 @@ into proprietary programs. If your program is a subroutine library, you
671671
may consider it more useful to permit linking proprietary applications with
672672
the library. If this is what you want to do, use the GNU Lesser General
673673
Public License instead of this License. But first, please read
674-
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
674+
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -98,20 +98,20 @@ features can be selectively disabled:
9898
cargo build --no-default-features --features clipboard,logger,notifications
9999
```
100100

101-
| Feature | What it adds | Extra dependency |
102-
| --------------- | --------------------------------------------------------------- | ------------------------- |
103-
| `jpeg` | JPEG encoding (`--encoding` / `.jpg`) | via `image` |
104-
| `pnm` | PNM/PPM encoding (`--encoding` / `.ppm`) | via `image` |
105-
| `qoi` | QOI encoding (`--encoding` / `.qoi`) | via `image` |
106-
| `webp` | WebP encoding (`--encoding` / `.webp`) | via `image` |
107-
| `avif` | AVIF encoding (`--encoding` / `.avif`) | rav1e (via `image`) |
108-
| `clipboard` | `--clipboard` flag, copy to Wayland clipboard | wl-clipboard-rs |
109-
| `color_picker` | `--color` flag, freeze screen and pick a pixel color ||
110-
| `jxl` | JPEG-XL encoding (`--encoding` / `.jxl`) | `jxl-encoder` |
111-
| `logger` | `--log-level` flag, tracing output to stderr | tracing-subscriber |
101+
| Feature | What it adds | Extra dependency |
102+
| --------------- | ------------------------------------------------------------------- | ------------------------- |
103+
| `jpeg` | JPEG encoding (`--encoding` / `.jpg`) | via `image` |
104+
| `pnm` | PNM/PPM encoding (`--encoding` / `.ppm`) | via `image` |
105+
| `qoi` | QOI encoding (`--encoding` / `.qoi`) | via `image` |
106+
| `webp` | WebP encoding (`--encoding` / `.webp`) | via `image` |
107+
| `avif` | AVIF encoding (`--encoding` / `.avif`) | rav1e (via `image`) |
108+
| `clipboard` | `--clipboard` flag, copy to Wayland clipboard | wl-clipboard-rs |
109+
| `color_picker` | `--color` flag, freeze screen and pick a pixel color ||
110+
| `jxl` | JPEG-XL encoding (`--encoding` / `.jxl`) | `jxl-encoder` |
111+
| `logger` | `--log-level` flag, tracing output to stderr | tracing-subscriber |
112112
| `notifications` | Desktop notifications after each capture; configurable click action | notify-rust, rustix |
113-
| `selector` | `--geometry` flag, interactive region selection | libwaysip |
114-
| `completions` | `--completions <SHELL>` flag, generate shell completion scripts | clap_complete (+ nushell) |
113+
| `selector` | `--geometry` flag, interactive region selection | libwaysip |
114+
| `completions` | `--completions <SHELL>` flag, generate shell completion scripts | clap_complete (+ nushell) |
115115

116116
## Clipboard without the built-in feature
117117

0 commit comments

Comments
 (0)