Deploying to gh-pages from @ c80c0ad 🚀

_downloads/621e2c7711e8623173875c33222eddb6/changelog.yaml

@@ -562,3 +562,8 @@
     - Replaced unsafe numpy-Python comparison with use of numpy dtype to convert byte-string
       arrays to Unicode ones within enums
   date: 2024-05-13 16:26:53
+- bump: patch
+  changes:
+    fixed:
+    - Remove name metadata tag in docs.
+  date: 2024-05-14 15:27:27

_sources/usage/parameters.md

@@ -46,10 +46,11 @@ Each parameter (or parameter node) can also set **metadata**: data that describe
 Here's an example metadata specification for the `child_benefit.basic.amount` parameter:
 
 ```yaml
+description: The UK provides this Child Benefit per child.
+
 metadata:
-    name: child_benefit
     label: Child Benefit
-    description: The amount of Child Benefit paid per child.
+    period: year
     unit: currency-GBP
     reference: 
         - label: GOV.UK | Child Benefit

usage/parameters.html

@@ -277,10 +277,11 @@ <h2>Parameter values<a class="headerlink" href="#parameter-values" title="Permal
 <h2>Metadata<a class="headerlink" href="#metadata" title="Permalink to this heading">#</a></h2>
 <p>Each parameter (or parameter node) can also set <strong>metadata</strong>: data that describes the parameter, such as its name, description, and units. While the metadata for each parameter and node is freeform, using the schemas defined in <code class="docutils literal notranslate"><span class="pre">policyengine_core.data_structures</span></code> will ensure consistency between country packages, and better maintainability.</p>
 <p>Here’s an example metadata specification for the <code class="docutils literal notranslate"><span class="pre">child_benefit.basic.amount</span></code> parameter:</p>
-<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">metadata</span><span class="p">:</span>
-<span class="w">    </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">child_benefit</span>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">The UK provides this Child Benefit per child.</span>
+
+<span class="nt">metadata</span><span class="p">:</span>
 <span class="w">    </span><span class="nt">label</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Child Benefit</span>
-<span class="w">    </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">The amount of Child Benefit paid per child.</span>
+<span class="w">    </span><span class="nt">period</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">year</span>
 <span class="w">    </span><span class="nt">unit</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">currency-GBP</span>
 <span class="w">    </span><span class="nt">reference</span><span class="p">:</span><span class="w"> </span>
 <span class="w">        </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">label</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">GOV.UK | Child Benefit</span>