-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Add references to wiki #3306
Add references to wiki #3306
Conversation
…wiki-3110' into docs-references-to-examples-and-wiki-3110 # Conflicts: # telegram/ext/_application.py
If I add links to examples or Wiki not to the entire class, but to one of the args, do I add same links to both |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi, thanks for the PR! You found quite some places to put references, nice :) I left some comments where I thought that the added value of an additional reference is not so big (11 comments may sound like a lot, but compared to the number of your additions, that's only a few :D ).
If I add links to examples or Wiki not to the entire class, but to one of the args, do I add same links to both
Args:
andAttributes:
?
I guess I'd make it dependent one which one is used more frequently by the user. Stupid example: a user usually has no reason to build an instance of Job
manually, so in case you wanted to add something to Job.callback
, I'd add it to the attribute, not the argument.
Thank you for your feedback!
I was thinking the same way, but decided to ask with issue #3109 in mind (potential unification of args and attrs in docstrings). So OK, I'll proceed with this understanding. |
I finished adding stuff I had found :) |
Thank you for your comments! That should be it |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good and thorough work! Found some things which can be further refined-
.. seealso:: `Types of Handlers <https://github.com/\ | ||
python-telegram-bot/python-telegram-bot/wiki/Types-of-Handlers>`_ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not needed imo
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess I'll have to wait for comment from @Bibo-Joshi here because in this comment there was a suggestion that I should remove links to 2 examples (which I did) but not to "Types of Handlers" wiki (so I left it there)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm fine with either way. You were very thorough on adding referencings, so we're bound to have a few references that may not be necessary (depending on who's judging :D), but a few more is surely better than less :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok eh let's keep it
* Bot: move link to Your First Bot wiki to class docstring * Application: move link to Your First Bot and Architecture wiki pages to class docstring * InlineQueryHandler: remove link to Types of Handlers * JobQueue: remove duplicate link to Timerbot example * filters.py: remove link to Your First Bot * MessageHandler: move link to Advanced Filters from class docstring to `filters` arg
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
addresses #3110.