Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Two seemingly spurious sphinx warnings #178

Open
jobrachem opened this issue Jan 31, 2024 · 0 comments
Open

Two seemingly spurious sphinx warnings #178

jobrachem opened this issue Jan 31, 2024 · 0 comments
Assignees
Labels
comp:documentation Improvements or additions to the documentation

Comments

@jobrachem
Copy link
Contributor

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

@jobrachem jobrachem added the comp:documentation Improvements or additions to the documentation label Jan 31, 2024
@jobrachem jobrachem self-assigned this Jan 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
comp:documentation Improvements or additions to the documentation
Projects
None yet
Development

No branches or pull requests

1 participant