Skip to content

Commit

Permalink
Deploying to gh-pages from @ 7cb1d65 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
cgay committed Jun 12, 2024
1 parent beb6f7c commit eace9a7
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 10 deletions.
14 changes: 10 additions & 4 deletions _sources/library-reference/common-dylan/common-extensions.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ The extensions are:
.. generic-function:: condition-to-string
:open:

Returns a string representation of a condition object.
Returns a :drm:`<string>` representation of a condition object.

:signature: condition-to-string *condition* => *string*

Expand All @@ -142,9 +142,15 @@ The extensions are:
:description:

Returns a string representation of a general instance of
:drm:`<condition>`. There is a method on
:class:`<format-string-condition>` and method on
:drm:`<type-error>`.
:drm:`<condition>`.

Note that it is often not necessary to write a method on this generic
function for your condition classes because you can use the method
provided by :class:`<simple-condition>`, usually via one of its
subclasses, :drm:`<simple-error>`, :drm:`<simple-warning>`, or
:drm:`<simple-restart>`. Simply make your condition a subclass of one of
these classes and provide the ``format-string:`` and ``format-arguments:``
init keywords.

.. macro:: debug-assert
:statement:
Expand Down
16 changes: 11 additions & 5 deletions library-reference/common-dylan/common-extensions.html
Original file line number Diff line number Diff line change
Expand Up @@ -693,7 +693,7 @@ <h1>The common-extensions Module<a class="headerlink" href="#the-common-extensio
<dl class="dylan generic-function">
<dt class="sig sig-object dylan-api dylan" id="common-dylan:common-extensions:condition-to-string">
<span class="sig-name descname"><span class="pre">condition-to-string</span></span> <em class="property"><span class="pre">Open</span> <span class="pre">Generic</span> <span class="pre">function</span></em><a class="headerlink" href="#common-dylan:common-extensions:condition-to-string" title="Permalink to this definition"></a></dt>
<dd><p>Returns a string representation of a condition object.</p>
<dd><p>Returns a <a class="reference external" href="https://opendylan.org/books/drm/Collection_Classes#string"><code class="xref drm docutils literal notranslate"><span class="pre">&lt;string&gt;</span></code></a> representation of a condition object.</p>
<dl class="field-list simple">
<dt class="field-odd">Signature<span class="colon">:</span></dt>
<dd class="field-odd"><p>condition-to-string <em>condition</em> =&gt; <em>string</em></p>
Expand All @@ -709,10 +709,16 @@ <h1>The common-extensions Module<a class="headerlink" href="#the-common-extensio
</ul>
</dd>
<dt class="field-even">Discussion<span class="colon">:</span></dt>
<dd class="field-even"><p>Returns a string representation of a general instance of
<a class="reference external" href="https://opendylan.org/books/drm/Condition_Classes#condition"><code class="xref drm docutils literal notranslate"><span class="pre">&lt;condition&gt;</span></code></a>. There is a method on
<a class="reference internal" href="#common-dylan:common-extensions:[format-string-condition]"><code class="xref dylan dylan-class docutils literal notranslate"><span class="pre">&lt;format-string-condition&gt;</span></code></a> and method on
<a class="reference external" href="https://opendylan.org/books/drm/Condition_Classes#type-error"><code class="xref drm docutils literal notranslate"><span class="pre">&lt;type-error&gt;</span></code></a>.</p>
<dd class="field-even"><p><p>Returns a string representation of a general instance of
<a class="reference external" href="https://opendylan.org/books/drm/Condition_Classes#condition"><code class="xref drm docutils literal notranslate"><span class="pre">&lt;condition&gt;</span></code></a>.</p>
<p>Note that it is often not necessary to write a method on this generic
function for your condition classes because you can use the method
provided by <a class="reference internal" href="#common-dylan:common-extensions:[simple-condition]"><code class="xref dylan dylan-class docutils literal notranslate"><span class="pre">&lt;simple-condition&gt;</span></code></a>, usually via one of its
subclasses, <a class="reference external" href="https://opendylan.org/books/drm/Condition_Classes#simple-error"><code class="xref drm docutils literal notranslate"><span class="pre">&lt;simple-error&gt;</span></code></a>, <a class="reference external" href="https://opendylan.org/books/drm/Condition_Classes#simple-warning"><code class="xref drm docutils literal notranslate"><span class="pre">&lt;simple-warning&gt;</span></code></a>, or
<a class="reference external" href="https://opendylan.org/books/drm/Condition_Classes#simple-restart"><code class="xref drm docutils literal notranslate"><span class="pre">&lt;simple-restart&gt;</span></code></a>. Simply make your condition a subclass of one of
these classes and provide the <code class="docutils literal notranslate"><span class="pre">format-string:</span></code> and <code class="docutils literal notranslate"><span class="pre">format-arguments:</span></code>
init keywords.</p>
</p>
</dd>
</dl>
</dd></dl>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit eace9a7

Please sign in to comment.