From 62ce02f6b5e95b1bb9682cdce7e678350ad666d1 Mon Sep 17 00:00:00 2001 From: Ryan Russell Date: Fri, 27 May 2022 03:06:11 -0500 Subject: [PATCH] docs(various): Improve Readability (#4225) --- core/tauri-macros/CHANGELOG.md | 2 +- core/tauri-runtime/CHANGELOG.md | 2 +- core/tauri/CHANGELOG.md | 12 ++++++------ examples/navigation/README.md | 4 ++-- examples/state/README.md | 2 +- examples/streaming/README.md | 2 +- examples/updater/src-tauri/Cargo.toml | 2 +- tooling/api/CHANGELOG.md | 6 +++--- .../bench/tests/cpu_intensive/src-tauri/Cargo.toml | 2 +- .../bench/tests/files_transfer/src-tauri/Cargo.toml | 2 +- tooling/bench/tests/helloworld/src-tauri/Cargo.toml | 2 +- tooling/bundler/README.md | 2 +- tooling/cli/CHANGELOG.md | 2 +- tooling/cli/node/CHANGELOG.md | 2 +- 14 files changed, 22 insertions(+), 22 deletions(-) diff --git a/core/tauri-macros/CHANGELOG.md b/core/tauri-macros/CHANGELOG.md index ef33bb84f..f98095f87 100644 --- a/core/tauri-macros/CHANGELOG.md +++ b/core/tauri-macros/CHANGELOG.md @@ -149,7 +149,7 @@ Here is the logic flow that determines if JSON or JSON5 will be used to parse th - Fixes a name collision when the command function is named `invoke`. - [7862ec5](https://www.github.com/tauri-apps/tauri/commit/7862ec562fa70e3733263ce1f690d6cd2943c0b4) fix(macros): change invoke binding in generate handler ([#1804](https://www.github.com/tauri-apps/tauri/pull/1804)) on 2021-05-12 - Fixes a name collision when the command function is named `message` or `resolver`. - - [0b87532](https://www.github.com/tauri-apps/tauri/commit/0b875327067ca825ff6f6f26c9b2ce6fcb001e79) fix(macros): fix rest of command collisons ([#1805](https://www.github.com/tauri-apps/tauri/pull/1805)) on 2021-05-12 + - [0b87532](https://www.github.com/tauri-apps/tauri/commit/0b875327067ca825ff6f6f26c9b2ce6fcb001e79) fix(macros): fix rest of command collisions ([#1805](https://www.github.com/tauri-apps/tauri/pull/1805)) on 2021-05-12 - Fixes a name collision when the command function is named `cmd`. - [d36b726](https://www.github.com/tauri-apps/tauri/commit/d36b7269261d329dd7d7fcd4d5098f3fca167364) fix(macros): collision when command is named `cmd` ([#1802](https://www.github.com/tauri-apps/tauri/pull/1802)) on 2021-05-12 diff --git a/core/tauri-runtime/CHANGELOG.md b/core/tauri-runtime/CHANGELOG.md index 0248c1706..70940b39f 100644 --- a/core/tauri-runtime/CHANGELOG.md +++ b/core/tauri-runtime/CHANGELOG.md @@ -104,7 +104,7 @@ ## \[0.2.1] -- **Breaking change:** Removed `register_uri_scheme_protocol` from the `WebviewAttibutes` struct and renamed `register_global_uri_scheme_protocol` to `register_uri_scheme_protocol` on the `Builder` struct, which now takes a `Fn(&AppHandle, &http::Request) -> http::Response` closure. +- **Breaking change:** Removed `register_uri_scheme_protocol` from the `WebviewAttributes` struct and renamed `register_global_uri_scheme_protocol` to `register_uri_scheme_protocol` on the `Builder` struct, which now takes a `Fn(&AppHandle, &http::Request) -> http::Response` closure. - [539e4489](https://www.github.com/tauri-apps/tauri/commit/539e4489e0bac7029d86917e9982ea49e02fe489) refactor: custom protocol ([#2503](https://www.github.com/tauri-apps/tauri/pull/2503)) on 2021-08-23 - Migrate to latest custom protocol allowing `Partial content` streaming and Header parsing. - [539e4489](https://www.github.com/tauri-apps/tauri/commit/539e4489e0bac7029d86917e9982ea49e02fe489) refactor: custom protocol ([#2503](https://www.github.com/tauri-apps/tauri/pull/2503)) on 2021-08-23 diff --git a/core/tauri/CHANGELOG.md b/core/tauri/CHANGELOG.md index 4421eba9b..ea41e38df 100644 --- a/core/tauri/CHANGELOG.md +++ b/core/tauri/CHANGELOG.md @@ -362,7 +362,7 @@ these specific choices. - [1f988535](https://www.github.com/tauri-apps/tauri/commit/1f98853573a837dd0cfc2161b206a5033ec2da5e) chore(deps) Update Tauri Core ([#2480](https://www.github.com/tauri-apps/tauri/pull/2480)) on 2021-08-24 - The `api::process::Command` APIs are now hidden behind the `command` feature flag. - [eed01728](https://www.github.com/tauri-apps/tauri/commit/eed017287fed2ade689af4268e8b63b9c9f2e585) feat(core): add `shell > sidecar` allowlist and `process` feature flag \[TRI-037] ([#18](https://www.github.com/tauri-apps/tauri/pull/18)) on 2021-10-24 -- Add `tauri::api::path::log_dir` function to access the sugested log directory path. +- Add `tauri::api::path::log_dir` function to access the suggested log directory path. - [acbb3ae7](https://www.github.com/tauri-apps/tauri/commit/acbb3ae7bb0165846b9456aea103269f027fc548) feat: add Log directory ([#2736](https://www.github.com/tauri-apps/tauri/pull/2736)) on 2021-10-16 - [62c7a8ad](https://www.github.com/tauri-apps/tauri/commit/62c7a8ad30fd3031b8679960590e5ef3eef8e4da) chore(covector): prepare for `rc` release ([#3376](https://www.github.com/tauri-apps/tauri/pull/3376)) on 2022-02-10 - The `process`, `path` and `updater` APIs now takes a `tauri::Env` argument, used to force environment variables load on startup to prevent env var update attacks. @@ -418,7 +418,7 @@ these specific choices. - [a03b8554](https://www.github.com/tauri-apps/tauri/commit/a03b85545a4b0b61a598a43eabe96e03565dcaf0) fix(core): tray not closing on Windows ([#3351](https://www.github.com/tauri-apps/tauri/pull/3351)) on 2022-02-07 - Immediately listen to `tauri://window-created` event to catch it before the application triggers it. - [878b8b9a](https://www.github.com/tauri-apps/tauri/commit/878b8b9a1fc825b1ea34f955e053311409a1468d) fix(core): immediately listen to window-created, closes [#3297](https://www.github.com/tauri-apps/tauri/pull/3297) ([#3298](https://www.github.com/tauri-apps/tauri/pull/3298)) on 2022-02-04 -- The `tauri::Window#emit` functiow now correctly sends the event to all windows that has a registered listener. +- The `tauri::Window#emit` function now correctly sends the event to all windows that has a registered listener. **Breaking change:** `Window#emit_and_trigger` and `Window#emit` now requires the payload to be cloneable. - [9b340552](https://www.github.com/tauri-apps/tauri/commit/9b340552643a1d8b9311219101329ce23c9271ea) fix(core): window-specific event delivery, closes [#3302](https://www.github.com/tauri-apps/tauri/pull/3302) ([#3344](https://www.github.com/tauri-apps/tauri/pull/3344)) on 2022-02-06 - Allow using a fixed version for the Webview2 runtime via the `tauri > bundle > windows > webviewFixedRuntimePath` config option. @@ -543,7 +543,7 @@ Here is the logic flow that determines if JSON or JSON5 will be used to parse th - Fix missing asset protocol path.Now the protocol is `https://asset.localhost/path/to/file` on Windows. Lunix and macOS is still `asset://path/to/file`. - [994b5325](https://www.github.com/tauri-apps/tauri/commit/994b5325dd385f564b37fe1530c5d798dc925fff) fix: missing asset protocol path ([#2484](https://www.github.com/tauri-apps/tauri/pull/2484)) on 2021-08-23 -- **Breaking change:** Removed `register_uri_scheme_protocol` from the `WebviewAttibutes` struct and renamed `register_global_uri_scheme_protocol` to `register_uri_scheme_protocol` on the `Builder` struct, which now takes a `Fn(&AppHandle, &http::Request) -> http::Response` closure. +- **Breaking change:** Removed `register_uri_scheme_protocol` from the `WebviewAttributes` struct and renamed `register_global_uri_scheme_protocol` to `register_uri_scheme_protocol` on the `Builder` struct, which now takes a `Fn(&AppHandle, &http::Request) -> http::Response` closure. - [539e4489](https://www.github.com/tauri-apps/tauri/commit/539e4489e0bac7029d86917e9982ea49e02fe489) refactor: custom protocol ([#2503](https://www.github.com/tauri-apps/tauri/pull/2503)) on 2021-08-23 - Migrate to latest custom protocol allowing `Partial content` streaming and Header parsing. - [539e4489](https://www.github.com/tauri-apps/tauri/commit/539e4489e0bac7029d86917e9982ea49e02fe489) refactor: custom protocol ([#2503](https://www.github.com/tauri-apps/tauri/pull/2503)) on 2021-08-23 @@ -786,8 +786,8 @@ Here is the logic flow that determines if JSON or JSON5 will be used to parse th - [7765c7fa](https://www.github.com/tauri-apps/tauri/commit/7765c7fa281853ddfb26b6b17534df95eaede804) fix(core): invoke key injection on ES module, improve performance ([#2094](https://www.github.com/tauri-apps/tauri/pull/2094)) on 2021-06-27 - Improve invoke key code injection performance time rewriting code at compile time. - [7765c7fa](https://www.github.com/tauri-apps/tauri/commit/7765c7fa281853ddfb26b6b17534df95eaede804) fix(core): invoke key injection on ES module, improve performance ([#2094](https://www.github.com/tauri-apps/tauri/pull/2094)) on 2021-06-27 -- Enfore uniqueness of window label. - - [d18b5367](https://www.github.com/tauri-apps/tauri/commit/d18b5367a91fd53d408510b456897630c70abcca) feat(core): enfore label uniqueness, closes [#2067](https://www.github.com/tauri-apps/tauri/pull/2067) ([#2097](https://www.github.com/tauri-apps/tauri/pull/2097)) on 2021-06-27 +- Enforce uniqueness of window label. + - [d18b5367](https://www.github.com/tauri-apps/tauri/commit/d18b5367a91fd53d408510b456897630c70abcca) feat(core): enforce label uniqueness, closes [#2067](https://www.github.com/tauri-apps/tauri/pull/2067) ([#2097](https://www.github.com/tauri-apps/tauri/pull/2097)) on 2021-06-27 - `Window` is now `Send + Sync` on Windows. - [fe32afcc](https://www.github.com/tauri-apps/tauri/commit/fe32afcc933920d6282ae1d63b041b182278a031) fix(core): `Window` must be `Send + Sync` on Windows, closes [#2078](https://www.github.com/tauri-apps/tauri/pull/2078) ([#2093](https://www.github.com/tauri-apps/tauri/pull/2093)) on 2021-06-27 @@ -1369,7 +1369,7 @@ https://github.com/GoogleChromeLabs/json-parse-benchmark ## \[0.7.3] - Properly run the loopback command on Windows. -- Properly ignore the ${distDir}/index.html asset from the asset embbeding. Previously every asset with name matching /(.+)index.html$/g were ignored. +- Properly ignore the ${distDir}/index.html asset from the asset embedding. Previously every asset with name matching /(.+)index.html$/g were ignored. ## \[0.7.2] diff --git a/examples/navigation/README.md b/examples/navigation/README.md index 0c2bb4283..56eee2796 100644 --- a/examples/navigation/README.md +++ b/examples/navigation/README.md @@ -1,5 +1,5 @@ -# Naviagtion Example +# Navigation Example -A very simple Tauri Appplication with frontend navigation. +A very simple Tauri Application with frontend navigation. To execute run the following on the root directory of the repository: `cargo run --example navigation --features window-create`. diff --git a/examples/state/README.md b/examples/state/README.md index f6a401e40..bd11e72a4 100644 --- a/examples/state/README.md +++ b/examples/state/README.md @@ -1,5 +1,5 @@ # State example -A simple Tauri Appplication showcase the application State usage. +A simple Tauri Application showcase the application State usage. To execute run the following on the root directory of the repository: `cargo run --example state` diff --git a/examples/streaming/README.md b/examples/streaming/README.md index 4a1cf4f1b..2ece2f01d 100644 --- a/examples/streaming/README.md +++ b/examples/streaming/README.md @@ -1,5 +1,5 @@ # Streaming example -A simple Tauri Appplication showcase the streaming functionality. +A simple Tauri Application showcase the streaming functionality. To execute run the following on the root directory of the repository: `cargo run --example streaming`. diff --git a/examples/updater/src-tauri/Cargo.toml b/examples/updater/src-tauri/Cargo.toml index af8118e8d..a1a533aa7 100644 --- a/examples/updater/src-tauri/Cargo.toml +++ b/examples/updater/src-tauri/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "updater-example" version = "0.1.0" -description = "A very simple Tauri Appplication" +description = "A very simple Tauri Application" edition = "2021" rust-version = "1.57" license = "Apache-2.0 OR MIT" diff --git a/tooling/api/CHANGELOG.md b/tooling/api/CHANGELOG.md index 2c4c983a1..45c6ba124 100644 --- a/tooling/api/CHANGELOG.md +++ b/tooling/api/CHANGELOG.md @@ -54,7 +54,7 @@ - Add `fileDropEnabled` property to `WindowOptions` so you can now disable it when creating windows from js. - [1bfc32a3](https://www.github.com/tauri-apps/tauri/commit/1bfc32a3b2f31b962ce8a5c611b60cb008360923) fix(api.js): add `fileDropEnabled` to `WindowOptions`, closes [#2968](https://www.github.com/tauri-apps/tauri/pull/2968) ([#2989](https://www.github.com/tauri-apps/tauri/pull/2989)) on 2021-12-09 -- Add `logDir` function to the `path` module to access the sugested log directory. +- Add `logDir` function to the `path` module to access the suggested log directory. Add `BaseDirectory.Log` to the `fs` module. - [acbb3ae7](https://www.github.com/tauri-apps/tauri/commit/acbb3ae7bb0165846b9456aea103269f027fc548) feat: add Log directory ([#2736](https://www.github.com/tauri-apps/tauri/pull/2736)) on 2021-10-16 - [62c7a8ad](https://www.github.com/tauri-apps/tauri/commit/62c7a8ad30fd3031b8679960590e5ef3eef8e4da) chore(covector): prepare for `rc` release ([#3376](https://www.github.com/tauri-apps/tauri/pull/3376)) on 2022-02-10 @@ -128,7 +128,7 @@ ## \[1.0.0-beta.7] -- Fix missing asset protocol path.Now the protocol is `https://asset.localhost/path/to/file` on Windows. Lunix and macOS +- Fix missing asset protocol path.Now the protocol is `https://asset.localhost/path/to/file` on Windows. Linux and macOS is still `asset://path/to/file`. - [994b5325](https://www.github.com/tauri-apps/tauri/commit/994b5325dd385f564b37fe1530c5d798dc925fff) fix: missing asset protocol path ([#2484](https://www.github.com/tauri-apps/tauri/pull/2484)) on 2021-08-23 @@ -169,7 +169,7 @@ - You can now use `emit`, `listen` and `once` using the `appWindow` exported by the window module. - [5d7626f8](https://www.github.com/tauri-apps/tauri/commit/5d7626f89781a6ebccceb9ab3b2e8335aa7a0392) feat(api): WindowManager extends WebviewWindowHandle, add events docs ([#2146](https://www.github.com/tauri-apps/tauri/pull/2146)) on 2021-07-03 - Allow manipulating a spawned window directly using `WebviewWindow`, which now extends `WindowManager`. - - [d69b1cf6](https://www.github.com/tauri-apps/tauri/commit/d69b1cf6d7c13297073073d753e30fe1a22a09cb) feat(api): allow mananing windows created on JS ([#2154](https://www.github.com/tauri-apps/tauri/pull/2154)) on 2021-07-05 + - [d69b1cf6](https://www.github.com/tauri-apps/tauri/commit/d69b1cf6d7c13297073073d753e30fe1a22a09cb) feat(api): allow managing windows created on JS ([#2154](https://www.github.com/tauri-apps/tauri/pull/2154)) on 2021-07-05 ## \[1.0.0-beta.4] diff --git a/tooling/bench/tests/cpu_intensive/src-tauri/Cargo.toml b/tooling/bench/tests/cpu_intensive/src-tauri/Cargo.toml index 9e0e991b0..2b31e82f8 100644 --- a/tooling/bench/tests/cpu_intensive/src-tauri/Cargo.toml +++ b/tooling/bench/tests/cpu_intensive/src-tauri/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "bench_cpu_intensive" version = "0.1.0" -description = "A very simple Tauri Appplication" +description = "A very simple Tauri Application" edition = "2021" rust-version = "1.57" diff --git a/tooling/bench/tests/files_transfer/src-tauri/Cargo.toml b/tooling/bench/tests/files_transfer/src-tauri/Cargo.toml index d146c4228..4e824e6e2 100644 --- a/tooling/bench/tests/files_transfer/src-tauri/Cargo.toml +++ b/tooling/bench/tests/files_transfer/src-tauri/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "bench_files_transfer" version = "0.1.0" -description = "A very simple Tauri Appplication" +description = "A very simple Tauri Application" edition = "2021" rust-version = "1.57" diff --git a/tooling/bench/tests/helloworld/src-tauri/Cargo.toml b/tooling/bench/tests/helloworld/src-tauri/Cargo.toml index 4fcff3628..741c198ae 100644 --- a/tooling/bench/tests/helloworld/src-tauri/Cargo.toml +++ b/tooling/bench/tests/helloworld/src-tauri/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "bench_helloworld" version = "0.1.0" -description = "A very simple Tauri Appplication" +description = "A very simple Tauri Application" edition = "2021" rust-version = "1.57" diff --git a/tooling/bundler/README.md b/tooling/bundler/README.md index 61c28b1ad..e98cd3c2c 100644 --- a/tooling/bundler/README.md +++ b/tooling/bundler/README.md @@ -120,6 +120,6 @@ This program is licensed either under the terms of the [Apache Software License](http://www.apache.org/licenses/LICENSE-2.0), or the [MIT License](https://opensource.org/licenses/MIT). --> note, for bundle_dmg we have included a BSD 3 licenced binary `seticon`. +-> note, for bundle_dmg we have included a BSD 3 licensed binary `seticon`. https://github.com/sveinbjornt/osxiconutils/blob/master/seticon.m `tools/rust/cargo-tauri-bundle/src/bundle/templates/seticon` diff --git a/tooling/cli/CHANGELOG.md b/tooling/cli/CHANGELOG.md index c0b33035e..2842eb78f 100644 --- a/tooling/cli/CHANGELOG.md +++ b/tooling/cli/CHANGELOG.md @@ -23,7 +23,7 @@ - - Remove startup delay in `tauri dev` caused by checking for a newer cli version. The check is now done upon process exit. - Add `TAURI_SKIP_UPDATE_CHECK` env variable to skip checking for a newer CLI version. - [bbabc8cd](https://www.github.com/tauri-apps/tauri/commit/bbabc8cd1ea2c1f6806610fd2d533c99305d320c) fix(cli.rs): remove startup delay in `tauri dev` ([#3999](https://www.github.com/tauri-apps/tauri/pull/3999)) on 2022-04-29 -- Fix `tauri info` panic when a pacakage isn't installed. +- Fix `tauri info` panic when a package isn't installed. - [4f0f3187](https://www.github.com/tauri-apps/tauri/commit/4f0f3187c9e69262ef28350331b368c831ab930a) fix(cli.rs): fix `tauri info` panic when a package isn't installed, closes [#3985](https://www.github.com/tauri-apps/tauri/pull/3985) ([#3996](https://www.github.com/tauri-apps/tauri/pull/3996)) on 2022-04-29 - Added `$schema` support to `tauri.conf.json`. - [715cbde3](https://www.github.com/tauri-apps/tauri/commit/715cbde3842a916c4ebeab2cab348e1774b5c192) feat(config): add `$schema` to `tauri.conf.json`, closes [#3464](https://www.github.com/tauri-apps/tauri/pull/3464) ([#4031](https://www.github.com/tauri-apps/tauri/pull/4031)) on 2022-05-03 diff --git a/tooling/cli/node/CHANGELOG.md b/tooling/cli/node/CHANGELOG.md index a9180bd45..463b99174 100644 --- a/tooling/cli/node/CHANGELOG.md +++ b/tooling/cli/node/CHANGELOG.md @@ -23,7 +23,7 @@ - - Remove startup delay in `tauri dev` caused by checking for a newer cli version. The check is now done upon process exit. - Add `TAURI_SKIP_UPDATE_CHECK` env variable to skip checking for a newer CLI version. - [bbabc8cd](https://www.github.com/tauri-apps/tauri/commit/bbabc8cd1ea2c1f6806610fd2d533c99305d320c) fix(cli.rs): remove startup delay in `tauri dev` ([#3999](https://www.github.com/tauri-apps/tauri/pull/3999)) on 2022-04-29 -- Fix `tauri info` panic when a pacakage isn't installed. +- Fix `tauri info` panic when a package isn't installed. - [4f0f3187](https://www.github.com/tauri-apps/tauri/commit/4f0f3187c9e69262ef28350331b368c831ab930a) fix(cli.rs): fix `tauri info` panic when a package isn't installed, closes [#3985](https://www.github.com/tauri-apps/tauri/pull/3985) ([#3996](https://www.github.com/tauri-apps/tauri/pull/3996)) on 2022-04-29 - Added `$schema` support to `tauri.conf.json`. - [715cbde3](https://www.github.com/tauri-apps/tauri/commit/715cbde3842a916c4ebeab2cab348e1774b5c192) feat(config): add `$schema` to `tauri.conf.json`, closes [#3464](https://www.github.com/tauri-apps/tauri/pull/3464) ([#4031](https://www.github.com/tauri-apps/tauri/pull/4031)) on 2022-05-03