Deployed c05d7ab with MkDocs version: 1.6.1

amterp · Nov 30, 2024 · a546a3e · a546a3e
1 parent 0c5639c
commit a546a3e
Show file tree

Hide file tree

Showing 5 changed files with 116 additions and 12 deletions.
diff --git a/reference/ref-functions/index.html b/reference/ref-functions/index.html
@@ -915,6 +915,30 @@
       </ul>
     </nav>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#http" class="md-nav__link">
+    <span class="md-ellipsis">
+      HTTP
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="HTTP">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#http_get" class="md-nav__link">
+    <span class="md-ellipsis">
+      http_get
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
     </ul>
@@ -1393,6 +1417,30 @@
       </ul>
     </nav>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#http" class="md-nav__link">
+    <span class="md-ellipsis">
+      HTTP
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="HTTP">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#http_get" class="md-nav__link">
+    <span class="md-ellipsis">
+      http_get
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
     </ul>
@@ -1553,12 +1601,21 @@ <h3 id="epoch_nanos">epoch_nanos<a class="headerlink" href="#epoch_nanos" title=
 </code></pre></div>
 <h2 id="text">Text<a class="headerlink" href="#text" title="Permanent link">&para;</a></h2>
 <h3 id="upper">upper<a class="headerlink" href="#upper" title="Permanent link">&para;</a></h3>
+<ul>
+<li>Preserves string color attributes.</li>
+</ul>
 <div class="highlight"><pre><span></span><code>upper(input<span class="w"> </span><span class="k">any</span>)<span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span>string
 </code></pre></div>
 <h3 id="lower">lower<a class="headerlink" href="#lower" title="Permanent link">&para;</a></h3>
+<ul>
+<li>Preserves string color attributes.</li>
+</ul>
 <div class="highlight"><pre><span></span><code>lower(input<span class="w"> </span><span class="k">any</span>)<span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span>string
 </code></pre></div>
 <h3 id="replace">replace<a class="headerlink" href="#replace" title="Permanent link">&para;</a></h3>
+<ul>
+<li>Does <em>not</em> preserve string color attributes.</li>
+</ul>
 <p><strong>Parameters</strong>:</p>
 <ul>
 <li><code>input: string</code></li>
@@ -1583,6 +1640,9 @@ <h3 id="truncate">truncate<a class="headerlink" href="#truncate" title="Permanen
 <div class="highlight"><pre><span></span><code>truncate(input<span class="w"> </span>string,<span class="w"> </span>length<span class="w"> </span><span class="k">int</span>)<span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span>string
 </code></pre></div>
 <h3 id="split">split<a class="headerlink" href="#split" title="Permanent link">&para;</a></h3>
+<ul>
+<li>Does <em>not</em> preserve string color attributes.</li>
+</ul>
 <div class="highlight"><pre><span></span><code>split(input<span class="w"> </span>string,<span class="w"> </span>delimiter_regex<span class="w"> </span>string)<span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span>string[]
 </code></pre></div>
 <h2 id="maps">Maps<a class="headerlink" href="#maps" title="Permanent link">&para;</a></h2>
@@ -1605,14 +1665,26 @@ <h3 id="seed_random">seed_random<a class="headerlink" href="#seed_random" title=
 </code></pre></div>
 <h2 id="picking">Picking<a class="headerlink" href="#picking" title="Permanent link">&para;</a></h2>
 <h3 id="pick">pick<a class="headerlink" href="#pick" title="Permanent link">&para;</a></h3>
-<div class="highlight"><pre><span></span><code>pick(options<span class="w"> </span>string[],<span class="w"> </span>filter<span class="w"> </span>string?)
+<div class="highlight"><pre><span></span><code>pick(options<span class="w"> </span>string[],<span class="w"> </span>filter<span class="w"> </span>string?)<span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span>string
 </code></pre></div>
+<p>Named args:
+- <code>prompt</code></p>
 <h3 id="pick_kv">pick_kv<a class="headerlink" href="#pick_kv" title="Permanent link">&para;</a></h3>
-<div class="highlight"><pre><span></span><code>pick_kv(keys<span class="w"> </span>string[],<span class="w"> </span>values<span class="w"> </span>string[],<span class="w"> </span>filter<span class="w"> </span>string?)
+<div class="highlight"><pre><span></span><code>pick_kv(keys<span class="w"> </span>string[],<span class="w"> </span>values<span class="w"> </span>string[],<span class="w"> </span>filter<span class="w"> </span>string?)<span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span>string
 </code></pre></div>
+<p>Named args:
+- <code>prompt</code></p>
 <h3 id="pick_from_resource">pick_from_resource<a class="headerlink" href="#pick_from_resource" title="Permanent link">&para;</a></h3>
-<div class="highlight"><pre><span></span><code>pick_from_resource(resource_path<span class="w"> </span>string,<span class="w"> </span>filter<span class="w"> </span>string?)
+<div class="highlight"><pre><span></span><code>pick_from_resource(resource_path<span class="w"> </span>string,<span class="w"> </span>filter<span class="w"> </span>string?)<span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="k">any</span>...
+</code></pre></div>
+<h2 id="http">HTTP<a class="headerlink" href="#http" title="Permanent link">&para;</a></h2>
+<h3 id="http_get">http_get<a class="headerlink" href="#http_get" title="Permanent link">&para;</a></h3>
+<div class="highlight"><pre><span></span><code>http_get(url<span class="w"> </span>string,<span class="w"> </span>headers<span class="w"> </span>map?)<span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span>map
 </code></pre></div>
+<p>Map output contains the following keys:
+- <code>status_code</code>
+- <code>body</code></p>
+<p>Failed queries (e.g. invalid url, no response) will result in an error and script exit.</p>
 
 
 

diff --git a/search/search_index.json b/search/search_index.json
diff --git a/sitemap.xml b/sitemap.xml
@@ -2,34 +2,34 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://amterp.github.io/rad/</loc>
-         <lastmod>2024-11-18</lastmod>
+         <lastmod>2024-11-30</lastmod>
     </url>
     <url>
          <loc>https://amterp.github.io/rad/args/</loc>
-         <lastmod>2024-11-18</lastmod>
+         <lastmod>2024-11-30</lastmod>
     </url>
     <url>
          <loc>https://amterp.github.io/rad/defer/</loc>
-         <lastmod>2024-11-18</lastmod>
+         <lastmod>2024-11-30</lastmod>
     </url>
     <url>
          <loc>https://amterp.github.io/rad/functions/</loc>
-         <lastmod>2024-11-18</lastmod>
+         <lastmod>2024-11-30</lastmod>
     </url>
     <url>
          <loc>https://amterp.github.io/rad/rad-blocks/</loc>
-         <lastmod>2024-11-18</lastmod>
+         <lastmod>2024-11-30</lastmod>
     </url>
     <url>
          <loc>https://amterp.github.io/rad/shell-commands/</loc>
-         <lastmod>2024-11-18</lastmod>
+         <lastmod>2024-11-30</lastmod>
     </url>
     <url>
          <loc>https://amterp.github.io/rad/strings/</loc>
-         <lastmod>2024-11-18</lastmod>
+         <lastmod>2024-11-30</lastmod>
     </url>
     <url>
          <loc>https://amterp.github.io/rad/reference/ref-functions/</loc>
-         <lastmod>2024-11-18</lastmod>
+         <lastmod>2024-11-30</lastmod>
     </url>
 </urlset>
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
diff --git a/strings/index.html b/strings/index.html
@@ -455,6 +455,15 @@
       </ul>
     </nav>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#string-attributes" class="md-nav__link">
+    <span class="md-ellipsis">
+      String Attributes
+    </span>
+  </a>
+
 </li>
 
     </ul>
@@ -583,6 +592,15 @@
       </ul>
     </nav>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#string-attributes" class="md-nav__link">
+    <span class="md-ellipsis">
+      String Attributes
+    </span>
+  </a>
+
 </li>
 
     </ul>
@@ -632,6 +650,20 @@ <h3 id="backticks">Backticks<a class="headerlink" href="#backticks" title="Perma
 </ul>
 </li>
 </ul>
+<h2 id="string-attributes">String Attributes<a class="headerlink" href="#string-attributes" title="Permanent link">&para;</a></h2>
+<ul>
+<li>Not all strings are just plain text. They may have attributes such as color.</li>
+<li>This means that RSL contains logic on how to handle attributes when strings are combined or operated on</li>
+<li>e.g. concatenation, slicing, replace functions, etc</li>
+<li>The following operations maintain color attributes:</li>
+<li>concatenation</li>
+<li>index lookup</li>
+<li>The following <em>do not</em>, and just return a plain string:</li>
+<li>slicing (to be added)</li>
+<li>functions: <code>replace</code>, <code>split</code></li>
+<li>Attributes do <em>not</em> impact things like equality or comparing strings.</li>
+<li>A green string "Alice" and a yellow string "Alice" will be considered 'equal'.</li>
+</ul>