Skip to content

[BUG] Sphinx warnings #2281

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
Closed
Poolitzer opened this issue Dec 30, 2020 · 4 comments · Fixed by #2759
Closed

[BUG] Sphinx warnings #2281

Poolitzer opened this issue Dec 30, 2020 · 4 comments · Fixed by #2759
Labels
⚙️ documentation affected functionality: documentation 📋 help-wanted work status: help-wanted

Comments

@Poolitzer
Copy link
Member

These are the current warnings and we should try to fix them:

C:\Users\Poolitzer\PycharmProjects\python-telegram-bot\telegram\ext\basepersistence.py:docstring of telegram.ext.BasePersistence:16: WARNING: Inline interpreted text or phrase reference
 start-string without end-string.
C:\Users\Poolitzer\PycharmProjects\python-telegram-bot\telegram\ext\filters.py:docstring of telegram.ext.filters.Filters.dice:21: WARNING: duplicate object description of telegram.ext.f
ilters.Filters.dice, other instance in telegram.ext.filters, use :noindex: for one of them
C:\Users\Poolitzer\PycharmProjects\python-telegram-bot\telegram\ext\filters.py:docstring of telegram.ext.filters.Filters.document:29: WARNING: duplicate object description of telegram.e
xt.filters.Filters.audio, other instance in telegram.ext.filters, use :noindex: for one of them
C:\Users\Poolitzer\PycharmProjects\python-telegram-bot\telegram\ext\filters.py:docstring of telegram.ext.filters.Filters.group:1: WARNING: duplicate object description of telegram.ext.f
ilters.Filters.group, other instance in telegram.ext.filters, use :noindex: for one of them
C:\Users\Poolitzer\PycharmProjects\python-telegram-bot\telegram\ext\filters.py:docstring of telegram.ext.filters.Filters.private:1: WARNING: duplicate object description of telegram.ext
.filters.Filters.private, other instance in telegram.ext.filters, use :noindex: for one of them
C:\Users\Poolitzer\PycharmProjects\python-telegram-bot\telegram\ext\filters.py:docstring of telegram.ext.filters.Filters.sender_chat.channel:1: WARNING: duplicate object description of
telegram.ext.filters.Filters.sender_chat.channel, other instance in telegram.ext.filters, use :noindex: for one of them
C:\Users\Poolitzer\PycharmProjects\python-telegram-bot\telegram\ext\filters.py:docstring of telegram.ext.filters.Filters.sender_chat.super_group:1: WARNING: duplicate object description
 of telegram.ext.filters.Filters.sender_chat.super_group, other instance in telegram.ext.filters, use :noindex: for one of them
C:\Users\Poolitzer\PycharmProjects\python-telegram-bot\telegram\ext\filters.py:docstring of telegram.ext.filters.Filters.text:1: WARNING: duplicate object description of telegram.ext.fi
lters.Filters.text, other instance in telegram.ext.filters, use :noindex: for one of them
C:\Users\Poolitzer\PycharmProjects\python-telegram-bot\telegram\ext\filters.py:docstring of telegram.ext.filters.Filters.user.user_ids:1: WARNING: duplicate object description of telegr
am.ext.filters.Filters.user.user_ids, other instance in telegram.ext.filters, use :noindex: for one of them
C:\Users\Poolitzer\PycharmProjects\python-telegram-bot\telegram\ext\filters.py:docstring of telegram.ext.filters.Filters.via_bot.bot_ids:1: WARNING: duplicate object description of tele
gram.ext.filters.Filters.via_bot.bot_ids, other instance in telegram.ext.filters, use :noindex: for one of them
C:\Users\Poolitzer\PycharmProjects\python-telegram-bot\telegram\ext\filters.py:docstring of telegram.ext.filters.Filters.video:1: WARNING: duplicate object description of telegram.ext.f
ilters.Filters.video, other instance in telegram.ext.filters, use :noindex: for one of them
@Poolitzer Poolitzer added bug 🐛 📋 help-wanted work status: help-wanted ℹ️ good-first-issue information: good-first-issue ⚙️ documentation affected functionality: documentation labels Dec 30, 2020
@Poolitzer Poolitzer mentioned this issue Dec 30, 2020
Closed
@Bibo-Joshi
Copy link
Member

I tried fixing this without success and evenutally opened sphinx-doc/sphinx#8657.

@Bibo-Joshi
Copy link
Member

sphinx-doc/sphinx#8657 was closed as wontfix and I don't see any feasible way to fix this for our use case manually except documenting the classes like Filters._Document (which I'm pretty sure we don't want to). I'll leave this open for a while in case someone comes up with a clever idea. If not, I'll close as wontfix.

@Kunal-Kumar-Sahoo
Copy link

Hey I wanted to contribute to this problem. Can anyone tell me what exactly is the problem ?
I am new to open source so it takes me time to understand the problem :)

@Bibo-Joshi Bibo-Joshi removed the ℹ️ good-first-issue information: good-first-issue label Feb 3, 2021
@Bibo-Joshi
Copy link
Member

Thanks for the offer, @Kunal-Kumar-Sahoo, but unless you are familiar with the internals of sphinx and have an idea for a solution I guess I'll go ahead and close for the reasons mentioned above.

@github-actions github-actions bot locked and limited conversation to collaborators Feb 6, 2021
@harshil21 harshil21 linked a pull request Oct 30, 2021 that will close this issue
Overhaul of Filters #2759
Merged
3 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
⚙️ documentation affected functionality: documentation 📋 help-wanted work status: help-wanted
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Overhaul of Filters python-telegram-bot/python-telegram-bot
3 participants
@Bibo-Joshi @Poolitzer @Kunal-Kumar-Sahoo