Update documentation

scexao-org · Sep 6, 2024 · 6f7b81d · 6f7b81d
1 parent a4e33a5
commit 6f7b81d
Showing 1 changed file with 9 additions and 9 deletions.
diff --git a/api/utility.html b/api/utility.html
@@ -402,7 +402,7 @@ <h2> Contents </h2>
 </dl>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="vampires_dpp.constants.CMOSVAMPIRES.model_computed_fields">
-<span class="sig-name descname"><span class="pre">model_computed_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[dict[str,</span> <span class="pre">ComputedFieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#vampires_dpp.constants.CMOSVAMPIRES.model_computed_fields" title="Link to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">model_computed_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">ComputedFieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#vampires_dpp.constants.CMOSVAMPIRES.model_computed_fields" title="Link to this definition">#</a></dt>
 <dd><p>A dictionary of computed field names and their corresponding <cite>ComputedFieldInfo</cite> objects.</p>
 </dd></dl>
 
@@ -414,9 +414,9 @@ <h2> Contents </h2>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="vampires_dpp.constants.CMOSVAMPIRES.model_fields">
-<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cam_num':</span> <span class="pre">FieldInfo(annotation=Literal[1,</span> <span class="pre">2],</span> <span class="pre">required=True),</span> <span class="pre">'readmode':</span> <span class="pre">FieldInfo(annotation=Literal['fast',</span> <span class="pre">'slow'],</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#vampires_dpp.constants.CMOSVAMPIRES.model_fields" title="Link to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cam_num':</span> <span class="pre">FieldInfo(annotation=Literal[1,</span> <span class="pre">2],</span> <span class="pre">required=True),</span> <span class="pre">'readmode':</span> <span class="pre">FieldInfo(annotation=Literal['fast',</span> <span class="pre">'slow'],</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#vampires_dpp.constants.CMOSVAMPIRES.model_fields" title="Link to this definition">#</a></dt>
 <dd><p>Metadata about the fields defined on the model,
-mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
+mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] objects.</p>
 <p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
 </dd></dl>
 
@@ -435,7 +435,7 @@ <h2> Contents </h2>
 </dl>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="vampires_dpp.constants.EMCCDVAMPIRES.model_computed_fields">
-<span class="sig-name descname"><span class="pre">model_computed_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[dict[str,</span> <span class="pre">ComputedFieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#vampires_dpp.constants.EMCCDVAMPIRES.model_computed_fields" title="Link to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">model_computed_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">ComputedFieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#vampires_dpp.constants.EMCCDVAMPIRES.model_computed_fields" title="Link to this definition">#</a></dt>
 <dd><p>A dictionary of computed field names and their corresponding <cite>ComputedFieldInfo</cite> objects.</p>
 </dd></dl>
 
@@ -447,9 +447,9 @@ <h2> Contents </h2>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="vampires_dpp.constants.EMCCDVAMPIRES.model_fields">
-<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cam_num':</span> <span class="pre">FieldInfo(annotation=Literal[1,</span> <span class="pre">2],</span> <span class="pre">required=True),</span> <span class="pre">'emgain':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#vampires_dpp.constants.EMCCDVAMPIRES.model_fields" title="Link to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cam_num':</span> <span class="pre">FieldInfo(annotation=Literal[1,</span> <span class="pre">2],</span> <span class="pre">required=True),</span> <span class="pre">'emgain':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#vampires_dpp.constants.EMCCDVAMPIRES.model_fields" title="Link to this definition">#</a></dt>
 <dd><p>Metadata about the fields defined on the model,
-mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
+mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] objects.</p>
 <p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
 </dd></dl>
 
@@ -462,7 +462,7 @@ <h2> Contents </h2>
 </dl>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="vampires_dpp.constants.InstrumentInfo.model_computed_fields">
-<span class="sig-name descname"><span class="pre">model_computed_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[dict[str,</span> <span class="pre">ComputedFieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#vampires_dpp.constants.InstrumentInfo.model_computed_fields" title="Link to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">model_computed_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">ComputedFieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#vampires_dpp.constants.InstrumentInfo.model_computed_fields" title="Link to this definition">#</a></dt>
 <dd><p>A dictionary of computed field names and their corresponding <cite>ComputedFieldInfo</cite> objects.</p>
 </dd></dl>
 
@@ -474,9 +474,9 @@ <h2> Contents </h2>
 
 <dl class="py attribute">
 <dt class="sig sig-object py" id="vampires_dpp.constants.InstrumentInfo.model_fields">
-<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#vampires_dpp.constants.InstrumentInfo.model_fields" title="Link to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#vampires_dpp.constants.InstrumentInfo.model_fields" title="Link to this definition">#</a></dt>
 <dd><p>Metadata about the fields defined on the model,
-mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
+mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] objects.</p>
 <p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
 </dd></dl>