Fixing CI issues.

stlab · Jun 6, 2024 · 4ff0911 · 4ff0911
1 parent 0182b59
commit 4ff0911
Show file tree

Hide file tree

Showing 35 changed files with 186 additions and 133 deletions.
diff --git a/.github/matrix.json b/.github/matrix.json
@@ -1,34 +1,34 @@
 {
-    "config": [
-        {
-            "name": "Linux GCC 13",
-            "compiler": "gcc",
-            "version": "13",
-            "os": "ubuntu-22.04"
-        },
-        {
-            "name": "Linux Clang 15",
-            "compiler": "clang",
-            "version": "15",
-            "os": "ubuntu-22.04"
-        },
-        {
-            "name": "macOS apple-clang 15.1.0",
-            "compiler": "apple-clang",
-            "version": "15.1.0",
-            "os": "macos-13"
-        },
-        {
-            "name": "Windows VS2022",
-            "compiler": "Visual Studio",
-            "version": "17",
-            "os": "windows-2022",
-            "cmake_toolset": "Visual Studio 17 2022"
-        },
-        {
-            "name": "Linux Webassembly",
-            "compiler": "emscripten",
-            "os": "ubuntu-22.04"
-        }
-    ]
+  "config": [
+    {
+      "name": "Linux GCC 14",
+      "compiler": "gcc",
+      "version": "14",
+      "os": "ubuntu-22.04"
+    },
+    {
+      "name": "Linux Clang 15",
+      "compiler": "clang",
+      "version": "15",
+      "os": "ubuntu-22.04"
+    },
+    {
+      "name": "macOS apple-clang 15.1.0",
+      "compiler": "apple-clang",
+      "version": "15.1.0",
+      "os": "macos-13"
+    },
+    {
+      "name": "Windows VS2022",
+      "compiler": "Visual Studio",
+      "version": "17",
+      "os": "windows-2022",
+      "cmake_toolset": "Visual Studio 17 2022"
+    },
+    {
+      "name": "Linux Webassembly",
+      "compiler": "emscripten",
+      "os": "ubuntu-22.04"
+    }
+  ]
 }
diff --git a/.github/workflows/stlab.yml b/.github/workflows/stlab.yml
@@ -30,7 +30,7 @@ jobs:
     name: ${{ matrix.config.name }}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4.1.6
 
       - name: Install dependencies // macOS
         if: ${{ startsWith(matrix.config.os, 'macos') }}

diff --git a/docs/README.md b/docs/README.md
@@ -9,21 +9,22 @@ Pull requests for typos, examples, and other improvements are welcome. To file a
 - **`master`:** [![master build](https://travis-ci.org/stlab/stlab.github.io.svg?branch=master)](https://travis-ci.org/stlab/stlab.github.io) [![master coverage](https://codecov.io/github/stlab/stlab.github.io/coverage.svg?branch=master)](https://codecov.io/gh/stlab/stlab.github.io/branch/master)
 
 - **`develop`:** [![develop build](https://travis-ci.org/stlab/stlab.github.io.svg?branch=develop)](https://travis-ci.org/stlab/stlab.github.io)
-[![develop coverage](https://codecov.io/github/stlab/stlab.github.io/coverage.svg?branch=develop)](https://codecov.io/gh/stlab/stlab.github.io/branch/develop)
+  [![develop coverage](https://codecov.io/github/stlab/stlab.github.io/coverage.svg?branch=develop)](https://codecov.io/gh/stlab/stlab.github.io/branch/develop)
 
 # Building (Mac)
 
 You'll need Homebrew to make sure you have the most recent version of Ruby.
 
 ## Setup
+
 1. Clone the repo
 2. `brew install ruby`
 3. `sudo gem install bundle jekyll github-pages liquid`
 
-
 Periodically run `gem update` and `bundle update` to make sure you have the latest jekyll tooling.
 
 ## Building Docs
+
 ```
 cd ./docs
 bundle exec jekyll serve --watch
@@ -33,6 +34,7 @@ Documentation viewable at `localhost:4000`
 Modifying sources should auto-regenerate the documentation
 
 ## Building Examples
+
 1. `./build.sh` will download dependencies, build, and run all the `*.cpp` files in the `libraries` directory.
 
 ## Running Hyde in Docker
@@ -52,6 +54,7 @@ Configure the build as follows:
 ```
 cd ../builds/hyde
 ccmake ../../libraries
+cd -
 ```
 
 Specify the following options:
@@ -74,14 +77,14 @@ Specify the following options:
 - Build the docker image per the instructions in the hyde repo, [current using the clang13 branch](https://github.com/adobe/hyde/tree/fosterbrereton/llvm13-updates).
 
 ```
-cd ../..
 docker run --platform linux/x86_64 --mount type=bind,source="$(pwd)/..",target=/mnt/host \
     --tty --interactive \
     hyde bash
 ```
 
 From the docker prompt
+
 ```
-cd /mnt/host/docs
+cd /mnt/host/libraries/docs
 ./generate_docs.sh
 ```
diff --git a/docs/includes/stlab/algorithm/reverse.hpp/f_reverse_nodes.md b/docs/includes/stlab/algorithm/reverse.hpp/f_reverse_nodes.md
@@ -3,9 +3,11 @@ layout: function
 title: reverse_nodes
 hyde:
   owner: sean-parent
-  brief: __MISSING__
+  brief: __INLINED__
   tags:
     - function
+  inline:
+    brief: _multiple descriptions_
   defined_in_file: stlab/algorithm/reverse.hpp
   overloads:
     "template <typename I>\nauto reverse_nodes(I, I) -> I":
@@ -16,15 +18,21 @@ hyde:
         - description: __OPTIONAL__
           name: last
           type: I
-      description: __MISSING__
+      description: __INLINED__
+      inline:
+        description:
+          - Reverses the range `[first, last)` and returns the beginning of the reversed range such that `[result, last)` is a valid range.
       return: __OPTIONAL__
       signature_with_names: "template <typename I>\nauto reverse_nodes(I first, I last) -> I"
     "template <typename R>\nauto reverse_nodes(R &) -> typename R::iterator":
       arguments:
         - description: __OPTIONAL__
           name: range
           type: R &
-      description: __MISSING__
+      description: __INLINED__
+      inline:
+        description:
+          - Reverses the range `range` and returns the beginning of the reversed range such that `[result, last)` is a valid range.
       return: __OPTIONAL__
       signature_with_names: "template <typename R>\nauto reverse_nodes(R & range) -> typename R::iterator"
   namespace:

diff --git a/docs/includes/stlab/concurrency/channel.hpp/channel_error/m_operator3D.md b/docs/includes/stlab/concurrency/channel.hpp/channel_error/m_operator3D.md
@@ -2,7 +2,7 @@
 layout: method
 title: operator=
 hyde:
-  owner: __OPTIONAL__
+  owner: sean-parent
   brief: __OPTIONAL__
   tags:
     - method

diff --git a/docs/includes/stlab/concurrency/channel.hpp/channel_error/m_~channel_error.md b/docs/includes/stlab/concurrency/channel.hpp/channel_error/m_~channel_error.md
@@ -2,7 +2,7 @@
 layout: method
 title: ~channel_error
 hyde:
-  owner: __OPTIONAL__
+  owner: sean-parent
   brief: __OPTIONAL__
   tags:
     - method

diff --git a/docs/includes/stlab/concurrency/channel.hpp/identity/m_identity.md b/docs/includes/stlab/concurrency/channel.hpp/identity/m_identity.md
@@ -2,7 +2,7 @@
 layout: method
 title: identity
 hyde:
-  owner: __OPTIONAL__
+  owner: sean-parent
   brief: __OPTIONAL__
   tags:
     - method

diff --git a/docs/includes/stlab/concurrency/channel.hpp/identity/m_~identity.md b/docs/includes/stlab/concurrency/channel.hpp/identity/m_~identity.md
@@ -2,7 +2,7 @@
 layout: method
 title: ~identity
 hyde:
-  owner: __OPTIONAL__
+  owner: sean-parent
   brief: __OPTIONAL__
   tags:
     - method

diff --git a/docs/includes/stlab/concurrency/executor_base.hpp/executor/m_executor.md b/docs/includes/stlab/concurrency/executor_base.hpp/executor/m_executor.md
@@ -2,7 +2,7 @@
 layout: method
 title: executor
 hyde:
-  owner: __OPTIONAL__
+  owner: sean-parent
   brief: __OPTIONAL__
   tags:
     - method

diff --git a/docs/includes/stlab/concurrency/executor_base.hpp/executor/m_operator3D.md b/docs/includes/stlab/concurrency/executor_base.hpp/executor/m_operator3D.md
@@ -2,7 +2,7 @@
 layout: method
 title: operator=
 hyde:
-  owner: __OPTIONAL__
+  owner: sean-parent
   brief: __OPTIONAL__
   tags:
     - method

diff --git a/docs/includes/stlab/concurrency/future.hpp/future/f_operator213D.md b/docs/includes/stlab/concurrency/future.hpp/future/f_operator213D.md
@@ -8,28 +8,28 @@ hyde:
     - function
   defined_in_file: stlab/concurrency/future.hpp
   overloads:
-    auto operator!=(const future<T, typename enable_if<!smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &, const future<T, typename enable_if<!smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &) -> bool:
+    auto operator!=(const future<T, typename enable_if<!smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &, const future<T, typename enable_if<!smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &) -> bool:
       arguments:
         - description: __OPTIONAL__
           name: x
-          type: const future<T, typename enable_if<!smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &
+          type: const future<T, typename enable_if<!smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &
         - description: __OPTIONAL__
           name: y
-          type: const future<T, typename enable_if<!smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &
+          type: const future<T, typename enable_if<!smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &
       description: __MISSING__
       return: __OPTIONAL__
-      signature_with_names: auto operator!=(const future<T, typename enable_if<!smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> & x, const future<T, typename enable_if<!smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> & y) -> bool
-    auto operator!=(const future<T, typename enable_if<smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &, const future<T, typename enable_if<smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &) -> bool:
+      signature_with_names: auto operator!=(const future<T, typename enable_if<!smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> & x, const future<T, typename enable_if<!smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> & y) -> bool
+    auto operator!=(const future<T, typename enable_if<smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &, const future<T, typename enable_if<smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &) -> bool:
       arguments:
         - description: __OPTIONAL__
           name: x
-          type: const future<T, typename enable_if<smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &
+          type: const future<T, typename enable_if<smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &
         - description: __OPTIONAL__
           name: y
-          type: const future<T, typename enable_if<smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &
+          type: const future<T, typename enable_if<smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &
       description: __MISSING__
       return: __OPTIONAL__
-      signature_with_names: auto operator!=(const future<T, typename enable_if<smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> & x, const future<T, typename enable_if<smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> & y) -> bool
+      signature_with_names: auto operator!=(const future<T, typename enable_if<smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> & x, const future<T, typename enable_if<smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> & y) -> bool
     auto operator!=(const stlab::future<void> &, const stlab::future<void> &) -> bool:
       arguments:
         - description: __OPTIONAL__

diff --git a/docs/includes/stlab/concurrency/future.hpp/future/f_operator3D3D.md b/docs/includes/stlab/concurrency/future.hpp/future/f_operator3D3D.md
@@ -8,28 +8,28 @@ hyde:
     - function
   defined_in_file: stlab/concurrency/future.hpp
   overloads:
-    auto operator==(const future<T, typename enable_if<!smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &, const future<T, typename enable_if<!smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &) -> bool:
+    auto operator==(const future<T, typename enable_if<!smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &, const future<T, typename enable_if<!smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &) -> bool:
       arguments:
         - description: __OPTIONAL__
           name: x
-          type: const future<T, typename enable_if<!smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &
+          type: const future<T, typename enable_if<!smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &
         - description: __OPTIONAL__
           name: y
-          type: const future<T, typename enable_if<!smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &
+          type: const future<T, typename enable_if<!smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &
       description: __MISSING__
       return: __OPTIONAL__
-      signature_with_names: auto operator==(const future<T, typename enable_if<!smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> & x, const future<T, typename enable_if<!smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> & y) -> bool
-    auto operator==(const future<T, typename enable_if<smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &, const future<T, typename enable_if<smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &) -> bool:
+      signature_with_names: auto operator==(const future<T, typename enable_if<!smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> & x, const future<T, typename enable_if<!smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> & y) -> bool
+    auto operator==(const future<T, typename enable_if<smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &, const future<T, typename enable_if<smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &) -> bool:
       arguments:
         - description: __OPTIONAL__
           name: x
-          type: const future<T, typename enable_if<smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &
+          type: const future<T, typename enable_if<smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &
         - description: __OPTIONAL__
           name: y
-          type: const future<T, typename enable_if<smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &
+          type: const future<T, typename enable_if<smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &
       description: __MISSING__
       return: __OPTIONAL__
-      signature_with_names: auto operator==(const future<T, typename enable_if<smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> & x, const future<T, typename enable_if<smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> & y) -> bool
+      signature_with_names: auto operator==(const future<T, typename enable_if<smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> & x, const future<T, typename enable_if<smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> & y) -> bool
     auto operator==(const stlab::future<void> &, const stlab::future<void> &) -> bool:
       arguments:
         - description: __OPTIONAL__

diff --git a/docs/includes/stlab/concurrency/future.hpp/future/f_swap.md b/docs/includes/stlab/concurrency/future.hpp/future/f_swap.md
@@ -8,28 +8,28 @@ hyde:
     - function
   defined_in_file: stlab/concurrency/future.hpp
   overloads:
-    void swap(future<T, typename enable_if<!smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &, future<T, typename enable_if<!smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &):
+    void swap(future<T, typename enable_if<!smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &, future<T, typename enable_if<!smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &):
       arguments:
         - description: __OPTIONAL__
           name: x
-          type: future<T, typename enable_if<!smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &
+          type: future<T, typename enable_if<!smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &
         - description: __OPTIONAL__
           name: y
-          type: future<T, typename enable_if<!smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &
+          type: future<T, typename enable_if<!smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &
       description: __MISSING__
       return: __OPTIONAL__
-      signature_with_names: void swap(future<T, typename enable_if<!smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> & x, future<T, typename enable_if<!smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> & y)
-    void swap(future<T, typename enable_if<smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &, future<T, typename enable_if<smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &):
+      signature_with_names: void swap(future<T, typename enable_if<!smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> & x, future<T, typename enable_if<!smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> & y)
+    void swap(future<T, typename enable_if<smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &, future<T, typename enable_if<smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &):
       arguments:
         - description: __OPTIONAL__
           name: x
-          type: future<T, typename enable_if<smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &
+          type: future<T, typename enable_if<smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &
         - description: __OPTIONAL__
           name: y
-          type: future<T, typename enable_if<smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> &
+          type: future<T, typename enable_if<smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> &
       description: __MISSING__
       return: __OPTIONAL__
-      signature_with_names: void swap(future<T, typename enable_if<smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> & x, future<T, typename enable_if<smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type> & y)
+      signature_with_names: void swap(future<T, typename enable_if<smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> & x, future<T, typename enable_if<smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type> & y)
     void swap(stlab::future<void> &, stlab::future<void> &):
       arguments:
         - description: __OPTIONAL__

diff --git a/...e2C20T3E3A3Atype3E2C20void3E3A3Atype3E.md → ...ate3CT3E3A3Atype3E2C20void3E3A3Atype3E.md b/...e2C20T3E3A3Atype3E2C20void3E3A3Atype3E.md → ...ate3CT3E3A3Atype3E2C20void3E3A3Atype3E.md
@@ -1,17 +1,17 @@
 ---
 layout: method
-title: future<T, typename enable_if<smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type>
+title: future<T, typename enable_if<smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type>
 hyde:
-  owner: __OPTIONAL__
+  owner: sean-parent
   brief: __OPTIONAL__
   tags:
     - method
   defined_in_file: stlab/concurrency/future.hpp
   is_ctor: true
   overloads:
-    future<T, typename enable_if<smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type>():
+    future<T, typename enable_if<smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type>():
       annotation:
         - defaulted
       description: __OPTIONAL__
-      signature_with_names: future<T, typename enable_if<smart_is_copy_constructible_v<typename conditional<std::is_void_v<T>, monostate, T>::type>, void>::type>()
+      signature_with_names: future<T, typename enable_if<smart_is_copy_constructible_v<typename void_to_monostate<T>::type>, void>::type>()
 ---