OiO.lk Community platform!

Oio.lk is an excellent forum for developers, providing a wide range of resources, discussions, and support for those in the developer community. Join oio.lk today to connect with like-minded professionals, share insights, and stay updated on the latest trends and technologies in the development field.
  You need to log in or register to access the solved answers to this problem.
  • You have reached the maximum number of guest views allowed
  • Please register below to remove this limitation

Sphinx raises warnings for class derived from IntEnum - can I do something about it?

  • Thread starter Thread starter jobrachem
  • Start date Start date
J

jobrachem

Guest
As the title says. The warnings are:

Code:
docstring of liesel.goose.EpochType.from_bytes:9: WARNING: Inline interpreted text or phrase reference start-string without end-string.
docstring of liesel.goose.EpochType.to_bytes:8: WARNING: Inline interpreted text or phrase reference start-string without end-string.

I am using Sphinx version 7.2.6.

My investigation yielded the following:

The class EpochType is derived from enum.IntEnum. IntEnum is derived partly from int (source code on GitHub).

As far as I can see, the methods from_bytes and to_bytes originate from the corresponding methods on int.

I do not understand why sphinx is throwing this warning and/or what I can do about it.
<p>As the title says. The warnings are:</p>
<pre><code>docstring of liesel.goose.EpochType.from_bytes:9: WARNING: Inline interpreted text or phrase reference start-string without end-string.
docstring of liesel.goose.EpochType.to_bytes:8: WARNING: Inline interpreted text or phrase reference start-string without end-string.
</code></pre>
<p>I am using Sphinx version <code>7.2.6</code>.</p>
<p>My investigation yielded the following:</p>
<p>The class <code>EpochType</code> is derived from <a href="https://docs.python.org/3/library/enum.html#enum.IntEnum" rel="nofollow noreferrer"><code>enum.IntEnum</code></a>. IntEnum is derived partly from <code>int</code> (<a href="https://github.com/python/cpython/blob/b905fad83819ec9102ecfb97e3d8ab0aaddd9784/Lib/enum.py#L1315" rel="nofollow noreferrer">source code on GitHub</a>).</p>
<p>As far as I can see, the methods <a href="https://docs.python.org/3/library/stdtypes.html#int.from_bytes" rel="nofollow noreferrer"><code>from_bytes</code></a> and <a href="https://docs.python.org/3/library/stdtypes.html#int.to_bytes" rel="nofollow noreferrer"><code>to_bytes</code></a> originate from the corresponding methods on <code>int</code>.</p>
<p>I do not understand why sphinx is throwing this warning and/or what I can do about it.</p>
 
Top