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.

Sign up for GitHub

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

Jump to bottom

📘 Sphinx gives warnings #23

Closed
demberto opened this issue Sep 14, 2022 · 1 comment
Closed

📘 Sphinx gives warnings #23

demberto opened this issue Sep 14, 2022 · 1 comment
Labels
docs Improvements or additions to documentation
Milestone
2.0.0

Comments

@demberto
Copy link
Owner

Warnings like these, come from magic I do in docs/conf.py:

Inline interpreted text or phrase reference start-string without end-string.
@demberto demberto added the docs Improvements or additions to documentation label Sep 14, 2022
@demberto demberto added this to the PyFLP 2.0.0 milestone Sep 14, 2022
@demberto demberto changed the title docs: Sphinx gives warnings 📘 Sphinx gives warnings Sep 17, 2022
@demberto
Copy link
Owner Author

This issue is caused by appending an s to indicate plurality like this:

:attr:`Insert`s

There's no solution to this other than replacing it with a separate word that conveys the meaning:

:attr:`Insert` instances

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Improvements or additions to documentation
Projects
None yet
Milestone
2.0.0
Development

No branches or pull requests
1 participant
@demberto