search

liesel-devs / liesel

A probabilistic programming framework
https://liesel-project.org
MIT License
38 stars 2 forks source link

Two seemingly spurious sphinx warnings #178

Open jobrachem opened 6 months ago

jobrachem commented 6 months ago

After updating Sphinx to version 7.2.6, it raises the following warnings.

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.

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. I created a question on stackoverflow: https://stackoverflow.com/questions/77914856/sphinx-raises-warnings-for-class-derived-from-intenum-can-i-do-something-about