CI: Add a typos job & fix various ones

bilelmoussaoui · bilelmoussaoui · commit e266a52ba091 · 2023-09-02T11:10:52.000+02:00
diff --git a/.github/workflows/typos.yml b/.github/workflows/typos.yml
@@ -0,0 +1,15 @@
+name: CI
+on:
+  pull_request:
+  push:
+    branches:
+      - "master"
+jobs:
+  typos:
+    name: Spell Check with Typos
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Actions Repository
+        uses: actions/checkout@v3
+      - name: Check spelling
+        uses: crate-ci/typos@master
diff --git a/.typos.toml b/.typos.toml
@@ -0,0 +1,8 @@
+[files]
+extend-exclude = ["*.svg"]
+
+[default.extend-words]
+# Ignore false-positives
+gir = "gir"
+relm = "relm"
+daa84 = "daa84"
diff --git a/_posts/2017-11-26-new-release.md b/_posts/2017-11-26-new-release.md
@@ -8,7 +8,7 @@ date: 2017-11-26 16:00:00 +0000
 
 Hi everyone!
 
-This release was supposed to be a minor one and to be released a lot sooner. However, as the time passed, `gtk-rs` developers weren't happy with what they had. There was always that little (but still wonderful) thing missing that we absolutely wanted to have. Suddenly, huges improvements came in and breaking changes as well. And this, is exactly how you end up from some very little and quicky release to medium and huge one.
+This release was supposed to be a minor one and to be released a lot sooner. However, as the time passed, `gtk-rs` developers weren't happy with what they had. There was always that little (but still wonderful) thing missing that we absolutely wanted to have. Suddenly, huges improvements came in and breaking changes as well. And this, is exactly how you end up from some very little and quickly release to medium and huge one.
 
 So what took us so long to add? A lot of things, the list is quite long. You can check the pull requests below. Let's just focus on the main ones.
 
@@ -173,7 +173,7 @@ For the interested ones, here is the list of the (major) changes:
  * [Add version for Sha384](https://github.com/gtk-rs/glib/pull/227)
  * [For the CallbackGuard, print something to stderr and use abort() inst…](https://github.com/gtk-rs/glib/pull/225)
  * [Fix versioning](https://github.com/gtk-rs/glib/pull/221)
- * [Fix versionning](https://github.com/gtk-rs/glib/pull/220)
+ * [Fix versioning](https://github.com/gtk-rs/glib/pull/220)
  * [Fix crates version](https://github.com/gtk-rs/glib/pull/218)
  * [Add README for crates.io](https://github.com/gtk-rs/glib/pull/215)
  * [Be more precise when setting a property with invalid type](https://github.com/gtk-rs/glib/pull/214)
@@ -293,7 +293,7 @@ For the interested ones, here is the list of the (major) changes:
  * [Update authors](https://github.com/gtk-rs/gdk/pull/123)
  * [Update version](https://github.com/gtk-rs/gdk/pull/122)
  * [Separate Rectangle from cairo's](https://github.com/gtk-rs/gdk/pull/119)
- * [Reexport cairo::RectangleInt as Rectangle and use converions on it](https://github.com/gtk-rs/gdk/pull/117)
+ * [Reexport cairo::RectangleInt as Rectangle and use conversions on it](https://github.com/gtk-rs/gdk/pull/117)
  * [Add gio dependency](https://github.com/gtk-rs/gdk/pull/116)
  * [Enums](https://github.com/gtk-rs/gdk/pull/115)
  * [Bump versions](https://github.com/gtk-rs/gdk/pull/113)
@@ -438,6 +438,6 @@ Thanks to all of our contributors for their (awesome!) work for this release:
  * [@thk1](https://github.com/thk1)
  * [@lise-henry](https://github.com/lise-henry)
  * [@jeandudey](https://github.com/jeandudey)
- * [@daa84](https://github.com/daa84)
+ * [@data84](https://github.com/daa84)
  * [@Bruflot](https://github.com/Bruflot)
  * [@reddraggone9](https://github.com/reddraggone9)
diff --git a/_posts/2018-09-09-new-release.md b/_posts/2018-09-09-new-release.md
@@ -154,7 +154,7 @@ For the interested ones, here is the list of the (major) changes:
  * [Don't require a mutable main context in the futures/MemoryInputStream…](https://github.com/gtk-rs/gio/pull/114)
  * [Add dox check on windows as well](https://github.com/gtk-rs/gio/pull/113)
  * [Add tests on osx](https://github.com/gtk-rs/gio/pull/112)
- * [Remove unneded futures-executor dependency](https://github.com/gtk-rs/gio/pull/111)
+ * [Remove unneeded futures-executor dependency](https://github.com/gtk-rs/gio/pull/111)
  * [Add futures variants for all async functions.](https://github.com/gtk-rs/gio/pull/108)
  * [Various Source related cleanups and add PollableInputStream/PollableOutputStream](https://github.com/gtk-rs/gio/pull/106)
  * [Implement File::replace_contents_async manually](https://github.com/gtk-rs/gio/pull/109)
@@ -284,7 +284,7 @@ All this was possible thanks to the [gtk-rs/gir](https://github.com/gtk-rs/gir)
  * [Enum / Flags: generate user defined `derive`](https://github.com/gtk-rs/gir/pull/611)
  * [Add `use glib;` if class has async method](https://github.com/gtk-rs/gir/pull/610)
  * [Add ignore clipy warnings in sys](https://github.com/gtk-rs/gir/pull/609)
- * [Async exctraction](https://github.com/gtk-rs/gir/pull/602)
+ * [Async extraction](https://github.com/gtk-rs/gir/pull/602)
  * [Fix generating function body when out parameter has reserved name](https://github.com/gtk-rs/gir/pull/603)
  * [Make single_version_file accept path for "versions.txt"](https://github.com/gtk-rs/gir/pull/599)
  * [Rename "string" in string_type to "utf8" to match glib type](https://github.com/gtk-rs/gir/pull/598)
diff --git a/_posts/2019-02-21-new-release.md b/_posts/2019-02-21-new-release.md
@@ -366,7 +366,7 @@ All this was possible thanks to the [gtk-rs/gir](https://github.com/gtk-rs/gir)
  * [Add imports for async out parameters](https://github.com/gtk-rs/gir/pull/700)
  * [Remove references from TypeId usage](https://github.com/gtk-rs/gir/pull/703)
  * [handle aliases better](https://github.com/gtk-rs/gir/pull/702)
- * [Fix unstable super_calback's list for g_vfs_register_uri_scheme](https://github.com/gtk-rs/gir/pull/701)
+ * [Fix unstable super_callback's list for g_vfs_register_uri_scheme](https://github.com/gtk-rs/gir/pull/701)
  * [Check for known subtypes when deciding if a type is a final type](https://github.com/gtk-rs/gir/pull/698)
  * [Fix invalid gboolean generation](https://github.com/gtk-rs/gir/pull/699)
  * [Start of user callbacks generation](https://github.com/gtk-rs/gir/pull/667)
@@ -389,7 +389,7 @@ All this was possible thanks to the [gtk-rs/gir](https://github.com/gtk-rs/gir)
  * [Remove now unneeded use statements for the glib_wrapper! macro](https://github.com/gtk-rs/gir/pull/671)
  * [Implement basics for subclassing](https://github.com/gtk-rs/gir/pull/669)
  * [Default generate_display_trait](https://github.com/gtk-rs/gir/pull/668)
- * [Fix display and strenghten CI](https://github.com/gtk-rs/gir/pull/663)
+ * [Fix display and strengthen CI](https://github.com/gtk-rs/gir/pull/663)
  * [Generate Display impl for enums](https://github.com/gtk-rs/gir/pull/643)
  * [Add pub for modules to use them from the gir library](https://github.com/gtk-rs/gir/pull/665)
  * [Fix missing glib](https://github.com/gtk-rs/gir/pull/662)
diff --git a/_posts/2019-06-22-new-release.md b/_posts/2019-06-22-new-release.md
@@ -57,7 +57,7 @@ We talked about this change for a while and decided it was the best for our user
 
 We made some changes into `cairo` type hierarchies that led to a global improvement. To sum it up very shortly (thanks to [@SimonSapin](https://github.com/SimonSapin) for providing it!):
 
- 1. Patterns: pseudo-inheritence with Deref (like surfaces already do) instead of an enum of each pattern type.
+ 1. Patterns: pseudo-inheritance with Deref (like surfaces already do) instead of an enum of each pattern type.
  2. PDF/PS/SVG: a single surface type each instead of a public module, and restrict streams to `'static` to make them sound.
  3. XBC: a struct like other surface types, instead of a trait.
  4. Inherent methods instead of various extension traits
diff --git a/_posts/2019-12-15-new-release.md b/_posts/2019-12-15-new-release.md
@@ -298,7 +298,7 @@ For the interested ones, here is the list of the merged pull requests:
  * [Make AccelGroup::connect() and ::connect_by_path() more usable](https://github.com/gtk-rs/gtk/pull/915)
  * [Add renaming for WidgetExt::set_name and BuildableExt::set_name](https://github.com/gtk-rs/gtk/pull/917)
  * [Derive Default for builders](https://github.com/gtk-rs/gtk/pull/919)
- * [subclass/container: widget in set_focu_child should be Nullable](https://github.com/gtk-rs/gtk/pull/922)
+ * [subclass/container: widget in set_focus_child should be Nullable](https://github.com/gtk-rs/gtk/pull/922)
  * [subclass/widget: Implement default handling for parent events](https://github.com/gtk-rs/gtk/pull/921)
 
 [pangocairo](https://github.com/gtk-rs/pangocairo):
diff --git a/_posts/2020-07-04-new-release.md b/_posts/2020-07-04-new-release.md
@@ -191,7 +191,7 @@ For the interested ones, here is the list of the merged pull requests:
  * [gdk/gdk: build: Compute and export GDK backends](https://github.com/gtk-rs/sys/pull/167)
  * [GIR files focal update](https://github.com/gtk-rs/sys/pull/164)
  * [Add correct versions for get\_type functions](https://github.com/gtk-rs/sys/pull/171)
- * [Depend on cairo-sys when selectin v3\_24\_2 feature](https://github.com/gtk-rs/sys/pull/173)
+ * [Depend on cairo-sys when selecting v3\_24\_2 feature](https://github.com/gtk-rs/sys/pull/173)
  * [Use eprintln](https://github.com/gtk-rs/sys/pull/175)
 
 [glib](https://github.com/gtk-rs/glib):
diff --git a/_posts/2021-06-22-new-release.md b/_posts/2021-06-22-new-release.md
@@ -318,7 +318,7 @@ For the interested ones, here is the list of the merged pull requests:
  * [glib: rename remaining \_generic to \_values](https://github.com/gtk-rs/gtk3-rs/pull/315)
  * [glib: Derive Ord on Type](https://github.com/gtk-rs/gtk3-rs/pull/317)
  * [glib: Improve the API of Type](https://github.com/gtk-rs/gtk3-rs/pull/318)
- * [glib-macros: Forward the visibility of the type into the code generat…](https://github.com/gtk-rs/gtk3-rs/pull/321)
+ * [glib-macros: Forward the visibility of the type into the code generated](https://github.com/gtk-rs/gtk3-rs/pull/321)
  * [ connect\_unsafe: Refactor, then don't ignore the return\_type for null objects ](https://github.com/gtk-rs/gtk3-rs/pull/319)
  * [glib: `#[object_subclass]` proc macro.](https://github.com/gtk-rs/gtk3-rs/pull/335)
  * [glib: Move `type_data()` and `get_type()` to new `unsafe trait`](https://github.com/gtk-rs/gtk3-rs/pull/338)
@@ -333,7 +333,7 @@ For the interested ones, here is the list of the merged pull requests:
  * [glib: Fix compilation of listbox\_model example](https://github.com/gtk-rs/gtk3-rs/pull/355)
  * [glib: Don't offset property ids before calling ObjectImpl::set\_proper…](https://github.com/gtk-rs/gtk3-rs/pull/368)
  * [Add a GError derive macro](https://github.com/gtk-rs/gtk3-rs/pull/367)
- * [glib-macros: Fix typo: doman -&gt; domain](https://github.com/gtk-rs/gtk3-rs/pull/370)
+ * [glib-macros: Fix typo: domain -&gt; domain](https://github.com/gtk-rs/gtk3-rs/pull/370)
  * [Fix some clone @default-return handlings](https://github.com/gtk-rs/gtk3-rs/pull/373)
  * [Fix panic when there is no @default-panic and add more checks for clone macro](https://github.com/gtk-rs/gtk3-rs/pull/377)
  * [glib: Actually call the function in \_once wrappers](https://github.com/gtk-rs/gtk3-rs/pull/383)
@@ -624,7 +624,7 @@ For the interested ones, here is the list of the merged pull requests:
  * [misc: bump default features](https://github.com/gtk-rs/gtk4-rs/pull/264)
  * [Specify naming of types, signals & properties](https://github.com/gtk-rs/gtk4-rs/pull/269)
  * [Finish up prerequisites](https://github.com/gtk-rs/gtk4-rs/pull/265)
- * [Accomodate Gio changes](https://github.com/gtk-rs/gtk4-rs/pull/271)
+ * [Accommodate Gio changes](https://github.com/gtk-rs/gtk4-rs/pull/271)
  * [Put listings into the shared workspace](https://github.com/gtk-rs/gtk4-rs/pull/272)
  * [gtk: expose KeyvalTrigger](https://github.com/gtk-rs/gtk4-rs/pull/274)
  * [Update display of minimum supported Rust version](https://github.com/gtk-rs/gtk4-rs/pull/278)
@@ -655,7 +655,7 @@ For the interested ones, here is the list of the merged pull requests:
  * [Add examples to README](https://github.com/gtk-rs/gtk4-rs/pull/295)
  * [gtk: bind WidgetClass::query\_action](https://github.com/gtk-rs/gtk4-rs/pull/328)
  * [Rename ToGlib into IntoGlib](https://github.com/gtk-rs/gtk4-rs/pull/331)
- * [Accomodate changes in glib::Value](https://github.com/gtk-rs/gtk4-rs/pull/325)
+ * [Accommodate changes in glib::Value](https://github.com/gtk-rs/gtk4-rs/pull/325)
  * [gdk: make ContentProvider subclassable](https://github.com/gtk-rs/gtk4-rs/pull/314)
  * [Put modules of examples in separate files](https://github.com/gtk-rs/gtk4-rs/pull/330)
  * [gdk: manually bind ContentFormats::mime\_types](https://github.com/gtk-rs/gtk4-rs/pull/335)
@@ -850,8 +850,8 @@ All this was possible thanks to the [gir][gir] project as well:
  * [docs: fix a missing param due to not rebasing #1151](https://github.com/gtk-rs/gir/pull/1154)
  * [codegen: use C value instead of hardcoding it](https://github.com/gtk-rs/gir/pull/1152)
  * [docs: use doc\_ignore\_parameters for global functions as well](https://github.com/gtk-rs/gir/pull/1155)
- * [codgen: generate a builder method for objects with a Builder ](https://github.com/gtk-rs/gir/pull/1156)
- * [codgen: generate impl T if there are builder properties as well](https://github.com/gtk-rs/gir/pull/1159)
+ * [codegen: generate a builder method for objects with a Builder ](https://github.com/gtk-rs/gir/pull/1156)
+ * [codegen: generate impl T if there are builder properties as well](https://github.com/gtk-rs/gir/pull/1159)
  * [\[refactor\] Simplify handling of trait bounds and aliases](https://github.com/gtk-rs/gir/pull/1160)
  * [codegen/doc: Make extension trait docs link back to the type](https://github.com/gtk-rs/gir/pull/1168)
  * [docs: properly look for renamed enum members](https://github.com/gtk-rs/gir/pull/1166)
@@ -862,7 +862,7 @@ All this was possible thanks to the [gir][gir] project as well:
  * [enums,flags: Do not analyze imports if the type is not generated](https://github.com/gtk-rs/gir/pull/1169)
  * [Docs: refactored + GI Docgen support](https://github.com/gtk-rs/gir/pull/1161)
  * [docs: look for renamed properties getters/setters](https://github.com/gtk-rs/gir/pull/1172)
- * [codgen: make the builder method doc slightly better formatted](https://github.com/gtk-rs/gir/pull/1173)
+ * [codegen: make the builder method doc slightly better formatted](https://github.com/gtk-rs/gir/pull/1173)
  * [Generate doc aliases on items in wrapper! macro](https://github.com/gtk-rs/gir/pull/1176)
  * [use C const for flags variants](https://github.com/gtk-rs/gir/pull/1175)
  * [Fix sys crate name for bitfields](https://github.com/gtk-rs/gir/pull/1177)
diff --git a/_posts/2022-01-14-new-release.md b/_posts/2022-01-14-new-release.md
@@ -181,7 +181,7 @@ This solves one of the common problems when using `Cairo` in multi-threaded appl
 
 ### GIO bindings improvements
 
-The gio bindings saw many additions and improvements. Among other things it is now possible to implement the [`gio::Initable`](https://gtk-rs.org/gtk-rs-core/stable/0.15/docs/gio/struct.Initable.html) interface, the [`gio::IOExtention`](https://gtk-rs.org/gtk-rs-core/stable/0.15/docs/gio/struct.IOExtension.html) API is now available, and the [`gio::Task`](https://gtk-rs.org/gtk-rs-core/stable/0.15/docs/gio/struct.Task.html) bindings have been reworked to address soundness issues. More improvements to the `gio::Task` bindings are necessary for them to become nice to use from Rust.
+The gio bindings saw many additions and improvements. Among other things it is now possible to implement the [`gio::Initable`](https://gtk-rs.org/gtk-rs-core/stable/0.15/docs/gio/struct.Initable.html) interface, the [`gio::IOExtension`](https://gtk-rs.org/gtk-rs-core/stable/0.15/docs/gio/struct.IOExtension.html) API is now available, and the [`gio::Task`](https://gtk-rs.org/gtk-rs-core/stable/0.15/docs/gio/struct.Task.html) bindings have been reworked to address soundness issues. More improvements to the `gio::Task` bindings are necessary for them to become nice to use from Rust.
 
 ### Gdkwayland
 
@@ -416,7 +416,7 @@ For the interested ones, here is the list of the merged pull requests:
  * [book: Fix explanation in gobject memory management](https://github.com/gtk-rs/gtk4-rs/pull/589)
  * [book: Improve `todo_app` listing](https://github.com/gtk-rs/gtk4-rs/pull/583)
  * [Fixed small typo in Virtual methods example README](https://github.com/gtk-rs/gtk4-rs/pull/588)
- * [book: Use weak reference in `gobject_memory_managment`](https://github.com/gtk-rs/gtk4-rs/pull/590)
+ * [book: Use weak reference in `gobject_memory_management`](https://github.com/gtk-rs/gtk4-rs/pull/590)
  * [book: Rename listing app-id to org.gtk-rs](https://github.com/gtk-rs/gtk4-rs/pull/598)
  * [book: Finish up remainder of app-id](https://github.com/gtk-rs/gtk4-rs/pull/599)
  * [book: Mention that expressions only go in one direction](https://github.com/gtk-rs/gtk4-rs/pull/600)
@@ -568,7 +568,7 @@ All this was possible thanks to the [gtk-rs/gir](https://github.com/gtk-rs/gir)
  * [docs: allow to set `doc_struct_name` for global functions](https://github.com/gtk-rs/gir/pull/1285)
  * [codegen: trim extra `_async` in future variants](https://github.com/gtk-rs/gir/pull/1286)
  * [writer: check return code as `gboolean`](https://github.com/gtk-rs/gir/pull/1287)
- * [docs: avoid generating docs for uneeded properties getters/setters](https://github.com/gtk-rs/gir/pull/1289)
+ * [docs: avoid generating docs for unneeded properties getters/setters](https://github.com/gtk-rs/gir/pull/1289)
  * [parser: ignore private records](https://github.com/gtk-rs/gir/pull/1293)
  * [support fundamental types](https://github.com/gtk-rs/gir/pull/1294)
  * [analysis: don't take a slice of copy types by ref](https://github.com/gtk-rs/gir/pull/1296)
diff --git a/_posts/2022-10-18-new-release.md b/_posts/2022-10-18-new-release.md
@@ -140,7 +140,7 @@ pub trait ObjectImpl {
 }
 ```
 
-This caused a lot of confusion and was also redudant. Instead, starting with this release only the implementation struct is passed by reference, e.g.
+This caused a lot of confusion and was also redundant. Instead, starting with this release only the implementation struct is passed by reference, e.g.
 
 ```rust
 pub trait ObjectImpl {
@@ -375,7 +375,7 @@ For the interested ones, here is the list of the merged pull requests:
  * [Port Dockerfile to fedora rawhide and use system deps from git](https://github.com/gtk-rs/gtk-rs-core/pull/676)
  * [Implement `FusedIterator` for various custom iterators](https://github.com/gtk-rs/gtk-rs-core/pull/678)
  * [cairo: Fix user font callbacks.](https://github.com/gtk-rs/gtk-rs-core/pull/679)
- * [Add some more tests for various costum `Iterator` impls](https://github.com/gtk-rs/gtk-rs-core/pull/680)
+ * [Add some more tests for various custom `Iterator` impls](https://github.com/gtk-rs/gtk-rs-core/pull/680)
  * [Don't build gdk-pixbuf tests in the docker image](https://github.com/gtk-rs/gtk-rs-core/pull/682)
  * [gio: add AsyncInitable subclassing support](https://github.com/gtk-rs/gtk-rs-core/pull/654)
  * [gio: Use guard objects for `Application::hold()` and `mark\_busy()`](https://github.com/gtk-rs/gtk-rs-core/pull/685)
diff --git a/_posts/2023-02-09-new-release.md b/_posts/2023-02-09-new-release.md
@@ -331,7 +331,7 @@ For those who are interested, here is the list of the merged pull requests:
  * [no need to move in the hello world exercise](https://github.com/gtk-rs/gtk4-rs/pull/1254)
  * [Book: make memory management conclusion clearer.](https://github.com/gtk-rs/gtk4-rs/pull/1255)
  * [Use wrapper macros where possible](https://github.com/gtk-rs/gtk4-rs/pull/1256)
- * [Various improvments](https://github.com/gtk-rs/gtk4-rs/pull/1258)
+ * [Various improvements](https://github.com/gtk-rs/gtk4-rs/pull/1258)
  * [Allocations improvements](https://github.com/gtk-rs/gtk4-rs/pull/1259)
  * [gtk: Make use of `Value::from_type_unchecked`](https://github.com/gtk-rs/gtk4-rs/pull/1264)
  * [book: warn about precedence over pkg-config-lite](https://github.com/gtk-rs/gtk4-rs/pull/1263)
@@ -371,8 +371,8 @@ All this was possible thanks to the [gtk-rs/gir](https://github.com/gtk-rs/gir)
  * [codegen: silence deprecation warnings in impls for deprecated types/functions](https://github.com/gtk-rs/gir/pull/1408)
  * [analysis: handle C array pointer casts to void](https://github.com/gtk-rs/gir/pull/1407)
  * [fix the layout tests](https://github.com/gtk-rs/gir/pull/1409)
- * [codegen: Handle `_finish` functions not taking a GError inout param](https://github.com/gtk-rs/gir/pull/1397)
- * [Backport: codegen: Handle `_finish` functions not taking a GError inout param](https://github.com/gtk-rs/gir/pull/1411)
+ * [codegen: Handle `_finish` functions not taking a GError input param](https://github.com/gtk-rs/gir/pull/1397)
+ * [Backport: codegen: Handle `_finish` functions not taking a GError input param](https://github.com/gtk-rs/gir/pull/1411)
  * [analysis: Use the new move trait for in transfer-full params](https://github.com/gtk-rs/gir/pull/1384)
  * [analysis: Don't use IntoGlibPtr for `Vec<T>` parameters](https://github.com/gtk-rs/gir/pull/1412)
  * [analysis: Generate correct bounds when move is used for nullable types](https://github.com/gtk-rs/gir/pull/1413)
diff --git a/faq.md b/faq.md
