Updating docs for latest release.

stlab · Jan 26, 2025 · 7119aa8 · 7119aa8
1 parent d1016a8
commit 7119aa8
Show file tree

Hide file tree

Showing 7 changed files with 91 additions and 50 deletions.
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
@@ -1,10 +1,3 @@
-PATH
-  remote: ../../themes
-  specs:
-    jekyll-theme-adobe-hyde (2.0.2)
-      jekyll (~> 4.3)
-      jekyll-seo-tag (~> 2.0)
-
 GEM
   remote: https://rubygems.org/
   specs:
@@ -79,8 +72,6 @@ GEM
       rubyzip (>= 1.3.0, < 3.0)
     jekyll-sass-converter (3.0.0)
       sass-embedded (~> 1.54)
-    jekyll-seo-tag (2.8.0)
-      jekyll (>= 3.8, < 5.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
     kramdown (2.5.1)
@@ -176,7 +167,6 @@ DEPENDENCIES
   jekyll-compose
   jekyll-redirect-from
   jekyll-remote-theme
-  jekyll-theme-adobe-hyde!
   logger
 
 BUNDLED WITH

diff --git a/docs/_data/contributors.json b/docs/_data/contributors.json
@@ -41,7 +41,7 @@
     "type": "User",
     "user_view_type": "public",
     "site_admin": false,
-    "contributions": 150
+    "contributions": 162
   },
   {
     "login": "fosterbrereton",
@@ -285,28 +285,6 @@
     "site_admin": false,
     "contributions": 4
   },
-  {
-    "login": "Frans-Willem",
-    "id": 346213,
-    "node_id": "MDQ6VXNlcjM0NjIxMw==",
-    "avatar_url": "https://avatars.githubusercontent.com/u/346213?v=4",
-    "gravatar_id": "",
-    "url": "https://api.github.com/users/Frans-Willem",
-    "html_url": "https://github.com/Frans-Willem",
-    "followers_url": "https://api.github.com/users/Frans-Willem/followers",
-    "following_url": "https://api.github.com/users/Frans-Willem/following{/other_user}",
-    "gists_url": "https://api.github.com/users/Frans-Willem/gists{/gist_id}",
-    "starred_url": "https://api.github.com/users/Frans-Willem/starred{/owner}{/repo}",
-    "subscriptions_url": "https://api.github.com/users/Frans-Willem/subscriptions",
-    "organizations_url": "https://api.github.com/users/Frans-Willem/orgs",
-    "repos_url": "https://api.github.com/users/Frans-Willem/repos",
-    "events_url": "https://api.github.com/users/Frans-Willem/events{/privacy}",
-    "received_events_url": "https://api.github.com/users/Frans-Willem/received_events",
-    "type": "User",
-    "user_view_type": "public",
-    "site_admin": false,
-    "contributions": 3
-  },
   {
     "login": "dixlorenz",
     "id": 10881076,
@@ -329,6 +307,28 @@
     "site_admin": false,
     "contributions": 3
   },
+  {
+    "login": "Frans-Willem",
+    "id": 346213,
+    "node_id": "MDQ6VXNlcjM0NjIxMw==",
+    "avatar_url": "https://avatars.githubusercontent.com/u/346213?v=4",
+    "gravatar_id": "",
+    "url": "https://api.github.com/users/Frans-Willem",
+    "html_url": "https://github.com/Frans-Willem",
+    "followers_url": "https://api.github.com/users/Frans-Willem/followers",
+    "following_url": "https://api.github.com/users/Frans-Willem/following{/other_user}",
+    "gists_url": "https://api.github.com/users/Frans-Willem/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/Frans-Willem/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/Frans-Willem/subscriptions",
+    "organizations_url": "https://api.github.com/users/Frans-Willem/orgs",
+    "repos_url": "https://api.github.com/users/Frans-Willem/repos",
+    "events_url": "https://api.github.com/users/Frans-Willem/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/Frans-Willem/received_events",
+    "type": "User",
+    "user_view_type": "public",
+    "site_admin": false,
+    "contributions": 3
+  },
   {
     "login": "olnrao",
     "id": 3282354,

diff --git a/docs/_data/releases.json b/docs/_data/releases.json
@@ -1,4 +1,47 @@
 [
+  {
+    "url": "https://api.github.com/repos/stlab/libraries/releases/196795395",
+    "assets_url": "https://api.github.com/repos/stlab/libraries/releases/196795395/assets",
+    "upload_url": "https://uploads.github.com/repos/stlab/libraries/releases/196795395/assets{?name,label}",
+    "html_url": "https://github.com/stlab/libraries/releases/tag/v2.0.0a8",
+    "id": 196795395,
+    "author": {
+      "login": "sean-parent",
+      "id": 2279724,
+      "node_id": "MDQ6VXNlcjIyNzk3MjQ=",
+      "avatar_url": "https://avatars.githubusercontent.com/u/2279724?v=4",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/sean-parent",
+      "html_url": "https://github.com/sean-parent",
+      "followers_url": "https://api.github.com/users/sean-parent/followers",
+      "following_url": "https://api.github.com/users/sean-parent/following{/other_user}",
+      "gists_url": "https://api.github.com/users/sean-parent/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/sean-parent/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/sean-parent/subscriptions",
+      "organizations_url": "https://api.github.com/users/sean-parent/orgs",
+      "repos_url": "https://api.github.com/users/sean-parent/repos",
+      "events_url": "https://api.github.com/users/sean-parent/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/sean-parent/received_events",
+      "type": "User",
+      "user_view_type": "public",
+      "site_admin": false
+    },
+    "node_id": "RE_kwDOAiB0YM4LutwD",
+    "tag_name": "v2.0.0a8",
+    "target_commitish": "main",
+    "name": "v2.0.0.a8",
+    "draft": false,
+    "prerelease": true,
+    "created_at": "2025-01-25T23:47:32Z",
+    "published_at": "2025-01-26T00:28:14Z",
+    "assets": [
+
+    ],
+    "tarball_url": "https://api.github.com/repos/stlab/libraries/tarball/v2.0.0a8",
+    "zipball_url": "https://api.github.com/repos/stlab/libraries/zipball/v2.0.0a8",
+    "body": "## What's Changed\r\n* Static Analysis by @sean-parent in https://github.com/stlab/libraries/pull/546\r\n* Nix an unused matrix element by @dabrahams in https://github.com/stlab/libraries/pull/548\r\n* Update code base to pass clang-tidy by @sean-parent in https://github.com/stlab/libraries/pull/552\r\n* Reworked future reduction by @sean-parent in https://github.com/stlab/libraries/pull/551\r\n* Restructured CMake to simplify Windows build (and all builds) by @sean-parent in https://github.com/stlab/libraries/pull/553\r\n* Minor fixes to await and await docs. by @sean-parent in https://github.com/stlab/libraries/pull/555\r\n\r\n\r\n**Full Changelog**: https://github.com/stlab/libraries/compare/v2.0.0a7...v2.0.0a8",
+    "mentions_count": 2
+  },
   {
     "url": "https://api.github.com/repos/stlab/libraries/releases/152022568",
     "assets_url": "https://api.github.com/repos/stlab/libraries/releases/152022568/assets",

diff --git a/docs/_data/tags.json b/docs/_data/tags.json
@@ -1,4 +1,14 @@
 [
+  {
+    "name": "v2.0.0a8",
+    "zipball_url": "https://api.github.com/repos/stlab/libraries/zipball/refs/tags/v2.0.0a8",
+    "tarball_url": "https://api.github.com/repos/stlab/libraries/tarball/refs/tags/v2.0.0a8",
+    "commit": {
+      "sha": "d1016a8ef3cd4363ac568fa68e48c267d34d2b8c",
+      "url": "https://api.github.com/repos/stlab/libraries/commits/d1016a8ef3cd4363ac568fa68e48c267d34d2b8c"
+    },
+    "node_id": "MDM6UmVmMzU2ODEzNzY6cmVmcy90YWdzL3YyLjAuMGE4"
+  },
   {
     "name": "v2.0.0a7",
     "zipball_url": "https://api.github.com/repos/stlab/libraries/zipball/refs/tags/v2.0.0a7",
@@ -288,15 +298,5 @@
       "url": "https://api.github.com/repos/stlab/libraries/commits/1b106fe89318c855fef3dc56d81f98e0c26c2cff"
     },
     "node_id": "MDM6UmVmMzU2ODEzNzY6cmVmcy90YWdzL3YxLjA="
-  },
-  {
-    "name": "1.5.0",
-    "zipball_url": "https://api.github.com/repos/stlab/libraries/zipball/refs/tags/1.5.0",
-    "tarball_url": "https://api.github.com/repos/stlab/libraries/tarball/refs/tags/1.5.0",
-    "commit": {
-      "sha": "41446a20a734299caf9a20210c3b6bbb4250e35d",
-      "url": "https://api.github.com/repos/stlab/libraries/commits/41446a20a734299caf9a20210c3b6bbb4250e35d"
-    },
-    "node_id": "MDM6UmVmMzU2ODEzNzY6cmVmcy90YWdzLzEuNS4w"
   }
 ]
diff --git a/docs/include/stlab/concurrency/await.hpp/f_await.md b/docs/include/stlab/concurrency/await.hpp/f_await.md
@@ -7,8 +7,7 @@ hyde:
   tags:
     - function
   inline:
-    brief:
-      - "***********************************************************************************************"
+    brief: _multiple descriptions_
   defined_in_file: stlab/concurrency/await.hpp
   overloads:
     "template <class T>\nauto await(const future<T> &) -> T":
@@ -18,7 +17,10 @@ hyde:
         - description: __OPTIONAL__
           name: x
           type: const future<T> &
-      description: __MISSING__
+      description: __INLINED__
+      inline:
+        description:
+          - Equivalent to `await(copy(x))`.
       return: __OPTIONAL__
       signature_with_names: "template <class T>\nauto await(const future<T> & x) -> T"
     "template <class T>\nauto await(future<T> &&) -> T":
@@ -29,7 +31,7 @@ hyde:
       description: __INLINED__
       inline:
         description:
-          - "***********************************************************************************************"
+          - Synchronously wait for the result `x`. If `x` resolves as an exception, the exception is rethrown. When using the portable task system, an additional thread is added to the pool if no threads are available and the maximum number of threads has not been reached.
       return: __OPTIONAL__
       signature_with_names: "template <class T>\nauto await(future<T> && x) -> T"
   namespace:

diff --git a/docs/include/stlab/concurrency/await.hpp/f_await_for.md b/docs/include/stlab/concurrency/await.hpp/f_await_for.md
@@ -6,6 +6,9 @@ hyde:
   brief: "Wait for the specified duration for the future to be ready and either returns a ready future or a new future which can be waited on.\n"
   tags:
     - function
+  inline:
+    brief:
+      - Equivalent to `await_for(copy(x), timeout)`.
   defined_in_file: stlab/concurrency/await.hpp
   overloads:
     "template <class T>\nauto await_for(const future<T> &, const std::chrono::nanoseconds &) -> future<T>":
@@ -18,7 +21,10 @@ hyde:
         - description: __OPTIONAL__
           name: timeout
           type: const std::chrono::nanoseconds &
-      description: __MISSING__
+      description: __INLINED__
+      inline:
+        description:
+          - Equivalent to `await_for(copy(x), timeout)`.
       return: __OPTIONAL__
       signature_with_names: "template <class T>\nauto await_for(const future<T> & x, const std::chrono::nanoseconds & timeout) -> future<T>"
     "template <class T>\nauto await_for(future<T> &&, const std::chrono::nanoseconds &) -> future<T>":

diff --git a/docs/include/stlab/concurrency/await.hpp/f_invoke_waiting.md b/docs/include/stlab/concurrency/await.hpp/f_invoke_waiting.md
@@ -8,7 +8,7 @@ hyde:
     - function
   inline:
     brief:
-      - Assumes f _will wait_ and wakes or adds a thread to the thread pool (to the limit) before invoking f.
+      - Assumes `f` _will wait_ and wakes or adds a thread to the thread pool (to the limit) before invoking `f`. If using a condition variable, wrap the duration of the mutex lock in `f` to avoid deadlocks.
   defined_in_file: stlab/concurrency/await.hpp
   overloads:
     "template <class F>\nauto invoke_waiting(F &&)":
@@ -19,7 +19,7 @@ hyde:
       description: __INLINED__
       inline:
         description:
-          - Assumes f _will wait_ and wakes or adds a thread to the thread pool (to the limit) before invoking f.
+          - Assumes `f` _will wait_ and wakes or adds a thread to the thread pool (to the limit) before invoking `f`. If using a condition variable, wrap the duration of the mutex lock in `f` to avoid deadlocks.
       return: __OPTIONAL__
       signature_with_names: "template <class F>\nauto invoke_waiting(F && f)"
   namespace: