Skip to content

Commit

Permalink
Add inline comments and improve logging
Browse files Browse the repository at this point in the history
  • Loading branch information
dormant-user committed Aug 15, 2024
1 parent b51ed4c commit 9be5aea
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 34 deletions.
2 changes: 1 addition & 1 deletion docs/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ <h2 id="A">A</h2>
</li>
<li><a href="index.html#nctl.models.Concurrency.Config.arbitrary_types_allowed">arbitrary_types_allowed (nctl.models.Concurrency.Config attribute)</a>
</li>
<li><a href="index.html#nctl.aws.CloudFront.await_update">await_update() (nctl.aws.CloudFront method)</a>
<li><a href="index.html#nctl.aws.CloudFront.await_deploy">await_deploy() (nctl.aws.CloudFront method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
Expand Down
14 changes: 7 additions & 7 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ <h1>Welcome to NCTL’s documentation!<a class="headerlink" href="#welcome-to-nc
<dl class="py method">
<dt class="sig sig-object py" id="nctl.aws.CloudFront.update_distribution">
<span class="sig-name descname"><span class="pre">update_distribution</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">current_config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">origin_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#nctl.aws.CloudFront.update_distribution" title="Permalink to this definition"></a></dt>
<dd><p>Updates a cloudfront distribution.</p>
<dd><p>Updates the origin host of a cloudfront distribution.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>origin_name</strong> – Origin name that has to be replaced with.</p>
Expand All @@ -148,15 +148,15 @@ <h1>Welcome to NCTL’s documentation!<a class="headerlink" href="#welcome-to-nc
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="nctl.aws.CloudFront.store_config">
<span class="sig-name descname"><span class="pre">store_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">configuration</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#nctl.aws.CloudFront.store_config" title="Permalink to this definition"></a></dt>
<dd><p>Stores the cloudfront distribution config in a YAML file locally.</p>
<dt class="sig sig-object py" id="nctl.aws.CloudFront.await_deploy">
<span class="sig-name descname"><span class="pre">await_deploy</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#nctl.aws.CloudFront.await_deploy" title="Permalink to this definition"></a></dt>
<dd><p>Waits for the distribution to be deployed.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="nctl.aws.CloudFront.await_update">
<span class="sig-name descname"><span class="pre">await_update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">distribution_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#nctl.aws.CloudFront.await_update" title="Permalink to this definition"></a></dt>
<dd><p>Awaits the distribution update.</p>
<dt class="sig sig-object py" id="nctl.aws.CloudFront.store_config">
<span class="sig-name descname"><span class="pre">store_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">configuration</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#nctl.aws.CloudFront.store_config" title="Permalink to this definition"></a></dt>
<dd><p>Stores the cloudfront distribution config in a YAML file locally.</p>
</dd></dl>

</dd></dl>
Expand Down
Binary file modified docs/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 9be5aea

Please sign in to comment.