Add TODOs at bottom of pages (part 2)

john-cd · Oct 12, 2024 · 020fd63 · 020fd63
1 parent afaa867
commit 020fd63
Show file tree

Hide file tree

Showing 220 changed files with 657 additions and 32 deletions.
diff --git a/TODO.md b/TODO.md
@@ -12,42 +12,12 @@
 ## Markdown
 
 - [ ] review each .md file in turn
-- [ ] add explanation text for language pages
-- [ ] [Introduction](src/index.md) polish the intro
-- [ ] [Contributing](src/contributing/index.md)
-- [ ] [Rust installation and first steps](src/lang/rust_install.md) polish
-- [ ] [Main function](src/lang/main.md) add description
-- [ ] [Simple data types](src/lang/simple_data_types.md) add description
-- [ ] [Variables and constants](src/lang/variables_and_constants.md) add description
-- [ ] [Ownership and borrowing](src/lang/ownership_borrowing.md)   add description
-- [ ] [Slices](src/lang/slices.md)   add description
-- [ ] [Functions](src/lang/functions.md)   add description
-- [ ] [Control flow](src/lang/control_flow.md) add description
-- [ ] [Structs](src/lang/structs.md)
-- [ ] [Enums](src/lang/enums.md)
-- [ ] [Traits](src/lang/traits.md)
-- [ ] [Trait objects](src/lang/trait_objects.md)
-- [ ] [Attributes](src/lang/attributes.md)
-- [ ] [Generics](src/lang/generics.md)
-- [ ] [Lifetimes](src/lang/lifetimes.md)
-- [ ] [Modules and `use` keyword](src/lang/modules.md)
-- [ ] [Pattern matching, if / while let](src/lang/match.md)
-- [ ] [Closures](src/lang/closures.md)
-- [ ] [Iterators](src/lang/iterators.md)
-- [ ] [Macros](src/lang/macros.md)
-- [ ] [Standard library](src/standard_library/index.md)
-- [ ] [Option](src/standard_library/option.md) finish Option page map, unwrap_or
-- [ ] [Smart pointers](src/standard_library/smart_pointers.md)
-- [ ] [Crates (by category)](src/categories.md)
-- [ ] [About](src/about.md) rewrite
-- [ ] finish links:
-- [ ] create badge refdefs for links to crates.io, lib.rs, RBE book, etc
+- [ ] create badge refdefs for links to RBE book
 - [ ] pull request to little book of rust books
 - [ ] Consider adding project to <https://goodfirstissue.dev/language/rust>
 - [ ] review GA / GSC - issues with redirects??
 - [ ] incorporate cwd.rs example + any other new examples
 - [ ] finish word index
-- [ ] reenable [Index of Examples](src/examples_index.md)
 - [ ] finish cd_ci.md
 - [ ] finish improve_speed
 - [ ] finish to review ignore / no_run examples

diff --git a/src/categories.md b/src/categories.md
@@ -92,3 +92,6 @@
 [All Valid Categories]( https://crates.io/category_slugs )
 
 {{#include refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/algorithms/randomness.md b/src/categories/algorithms/randomness.md
@@ -70,3 +70,6 @@ Randomly generates a string of given length ASCII characters with custom user-de
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/algorithms/sorting.md b/src/categories/algorithms/sorting.md
@@ -34,3 +34,6 @@ Sorts a vector{{hi:Vector}} of Person structs with properties `name` and `age` b
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/api-bindings/index.md b/src/categories/api-bindings/index.md
@@ -24,3 +24,6 @@ Idiomatic wrappers of specific APIs{{hi:APIs}} for convenient access from Rust.
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/asynchronous/async.md b/src/categories/asynchronous/async.md
@@ -53,3 +53,6 @@ Alternatives to the Tokio async ecosystem include:
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/asynchronous/async_and_blocking.md b/src/categories/asynchronous/async_and_blocking.md
@@ -64,3 +64,6 @@ In other cases, it may be easier to structure the application as largely synchro
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/asynchronous/async_channels.incl.md b/src/categories/asynchronous/async_channels.incl.md
@@ -1,3 +1,6 @@
 | Recipe | Crates | Categories |
 |--------|--------|------------|
 |  |  | [![cat-asynchronous][cat-asynchronous-badge]][cat-asynchronous] |
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/asynchronous/async_channels.md b/src/categories/asynchronous/async_channels.md
@@ -38,3 +38,6 @@ Another example:
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/asynchronous/async_traits.md b/src/categories/asynchronous/async_traits.md
@@ -28,3 +28,6 @@ In addition, traits that use `-> impl Trait` and `async fn` are not object-safe{
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/asynchronous/futures.incl.md b/src/categories/asynchronous/futures.incl.md
@@ -1,3 +1,6 @@
 | Recipe | Crates | Categories |
 |--------|--------|------------|
 |  |  | [![cat-asynchronous][cat-asynchronous-badge]][cat-asynchronous] |
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/asynchronous/futures.md b/src/categories/asynchronous/futures.md
@@ -42,3 +42,6 @@ The [`futures`][c-futures]{{hi:futures}}⮳ crate provides an extension trait th
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/asynchronous/index.md b/src/categories/asynchronous/index.md
@@ -67,3 +67,6 @@ Alternatives to the Tokio async ecosystem include:
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/asynchronous/streams.incl.md b/src/categories/asynchronous/streams.incl.md
@@ -1,3 +1,6 @@
 | Recipe | Crates | Categories |
 |--------|--------|------------|
 |  |  | [![cat-asynchronous][cat-asynchronous-badge]][cat-asynchronous] |
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/asynchronous/streams.md b/src/categories/asynchronous/streams.md
@@ -26,3 +26,6 @@ See also Tokio `async_stream`{{hi:async_stream}}.
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/asynchronous/tokio.md b/src/categories/asynchronous/tokio.md
@@ -31,3 +31,6 @@ Example from [c-tokio_graceful_shutdown][c-tokio_graceful_shutdown]⮳:
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/caching/index.md b/src/categories/caching/index.md
@@ -12,3 +12,6 @@ Store the results of previous computations in order to reuse the results.
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/caching/lru.md b/src/categories/caching/lru.md
@@ -2,3 +2,7 @@
 ```rust,editable,no_run
 {{#include ../../../deps/tests/lru.rs}}
 ```
+
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/command-line-interface/ansi_terminal.md b/src/categories/command-line-interface/ansi_terminal.md
@@ -38,3 +38,6 @@ For anything more complex than plain foreground color changes, the code needs to
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/command-line-interface/arguments.md b/src/categories/command-line-interface/arguments.md
@@ -56,3 +56,6 @@ Your favorite number must be 256.
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/command-line-interface/index.md b/src/categories/command-line-interface/index.md
@@ -18,3 +18,6 @@ Techniques to help create command line interfaces{{hi:Command line interfaces}},
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/command-line-utilities/index.md b/src/categories/command-line-utilities/index.md
@@ -53,3 +53,6 @@ apt install gping
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/compilers/cross_compilation.md b/src/categories/compilers/cross_compilation.md
@@ -31,3 +31,6 @@ Examples: [![cross-toml-example][c-cross-toml-example-badge]][c-cross-toml-examp
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/compilers/faster_linking.md b/src/categories/compilers/faster_linking.md
@@ -60,3 +60,6 @@ rustflags = ["-C", "link-arg=-fuse-ld=/usr/bin/mold"]
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/compilers/index.md b/src/categories/compilers/index.md
@@ -18,3 +18,6 @@ Compiler{{hi:Compiler}} implementations, including interpreters{{hi:Interpreters
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/compilers/reduce_compilation_duration.md b/src/categories/compilers/reduce_compilation_duration.md
@@ -56,3 +56,6 @@ From-scratch builds with incremental compilation{{hi:Incremental compilation}} e
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/compression/index.md b/src/categories/compression/index.md
@@ -6,3 +6,6 @@ Algorithms for making data smaller.
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/compression/tar.md b/src/categories/compression/tar.md
@@ -38,3 +38,6 @@ Iterate over the [`tar::Archive::entries`][c-tar::Archive::entries]{{hi:tar::Arc
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/computer-vision/index.incl.md b/src/categories/computer-vision/index.incl.md
@@ -1,3 +1,6 @@
 | Recipe | Crates | Categories |
 |---|---|---|
 | [Open CV][ex-open-cv] | | [![cat-computer-vision][cat-computer-vision-badge]][cat-computer-vision] |
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/concurrency/__actors.md b/src/categories/concurrency/__actors.md
@@ -27,3 +27,6 @@
 [Actors with `Tokio`][blog-actors-with-tokio]{{hi:Actors}}⮳
 
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/concurrency/index.md b/src/categories/concurrency/index.md
@@ -41,3 +41,6 @@ Here are the topics we’ll cover:
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/concurrency/message_passing.md b/src/categories/concurrency/message_passing.md
@@ -42,3 +42,6 @@ Example using specialized channels for tickers{{hi:Tickers}} and timeout{{hi:Tim
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/concurrency/multithreading.md b/src/categories/concurrency/multithreading.md
@@ -58,3 +58,6 @@ Rayon implements [`rayon::join`][c-rayon::join]{{hi:rayon::join}}⮳, [`rayon::j
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/concurrency/parallel.md b/src/categories/concurrency/parallel.md
@@ -76,3 +76,6 @@ This example generates thumbnails for all `jpg`{{hi:JPEG}} files in the current
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/concurrency/shared_state/concurrent_data_structures.incl.md b/src/categories/concurrency/shared_state/concurrent_data_structures.incl.md
@@ -1,3 +1,6 @@
 | Recipe | Crates | Categories |
 |---|---|---|
 |  |  | [![cat-concurrency][cat-concurrency-badge]][cat-concurrency] |
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/concurrency/shared_state/concurrent_data_structures.md b/src/categories/concurrency/shared_state/concurrent_data_structures.md
@@ -24,3 +24,6 @@
 
 {{#include refs.incl.md}}
 {{#include ../../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/concurrency/shared_state/index.md b/src/categories/concurrency/shared_state/index.md
@@ -54,3 +54,6 @@ The most common way to share an atomic variable is to put it into an [`std::sync
 
 {{#include refs.incl.md}}
 {{#include ../../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/concurrency/threads.md b/src/categories/concurrency/threads.md
@@ -83,3 +83,6 @@ Allocate memory for output image of given width and height with [`image::ImageBu
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/config/configuration.md b/src/categories/config/configuration.md
@@ -18,3 +18,6 @@
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/config/environment_variables.md b/src/categories/config/environment_variables.md
@@ -46,3 +46,6 @@ serde = { version = "1.0", features = ["derive"] }
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/config/index.md b/src/categories/config/index.md
@@ -12,3 +12,6 @@ Facilitate configuration management{{hi:configuration management}} for applicati
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/cryptography/encryption.md b/src/categories/cryptography/encryption.md
@@ -18,3 +18,6 @@ The salt is generated using [`ring::rand::SecureRandom::fill`][c-ring::rand::Sec
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/cryptography/hashing.md b/src/categories/cryptography/hashing.md
@@ -24,3 +24,6 @@ Uses [`ring::hmac`][c-ring::hmac]{{hi:ring::hmac}}⮳ to creates a [`ring::signa
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/cryptography/index.md b/src/categories/cryptography/index.md
@@ -12,3 +12,6 @@ Securing data.
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/data-structures/bitfield.md b/src/categories/data-structures/bitfield.md
@@ -14,3 +14,6 @@ Creates type-safe bitfield{{hi:bitfield}} type `MyFlags` with help of [`bitflags
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/data-structures/index.md b/src/categories/data-structures/index.md
@@ -6,3 +6,6 @@ Rust implementations of ways of organizing data suited for specific purposes.
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/database-implementations/index.md b/src/categories/database-implementations/index.md
@@ -8,3 +8,6 @@
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/database/index.md b/src/categories/database/index.md
@@ -16,3 +16,6 @@ Interface with database management systems{{hi:Database management systems}}.
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/database/postgres.md b/src/categories/database/postgres.md
@@ -36,3 +36,6 @@ This recipe lists the nationalities of the first 7999 artists in the database of
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/database/query_builders_orms.md b/src/categories/database/query_builders_orms.md
@@ -20,3 +20,6 @@
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>
diff --git a/src/categories/database/sqlite.md b/src/categories/database/sqlite.md
@@ -41,3 +41,6 @@ In the following example, colors add to a table having a unique constraint on th
 
 {{#include refs.incl.md}}
 {{#include ../../refs/link-refs.md}}
+<div class="hidden">
+TODO:
+</div>