Add references to wiki #3306

lemontree210 · 2022-10-23T17:58:02Z

addresses #3110.

…wiki-3110' into docs-references-to-examples-and-wiki-3110 # Conflicts: # telegram/ext/_application.py

lemontree210 · 2022-10-25T18:45:29Z

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: and Attributes:?

Bibo-Joshi

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: and Attributes:?

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.

telegram/_bot.py

telegram/_message.py

telegram/ext/_application.py

telegram/ext/_callbackqueryhandler.py

telegram/ext/_contexttypes.py

telegram/ext/_handler.py

telegram/ext/_updater.py

telegram/ext/filters.py

lemontree210 · 2022-10-25T20:59:49Z

Thank you for your feedback!

I guess I'd make it dependent one which one is used more frequently by the user.

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.

lemontree210 · 2022-10-26T10:06:03Z

I finished adding stuff I had found :)

telegram/_chat.py

telegram/ext/_callbackqueryhandler.py

lemontree210 · 2022-10-26T18:14:59Z

Thank you for your comments! That should be it

harshil21

good and thorough work! Found some things which can be further refined-

telegram/_bot.py

telegram/ext/_application.py

telegram/ext/_inlinequeryhandler.py

telegram/ext/_jobqueue.py

telegram/ext/_messagehandler.py

telegram/ext/filters.py

harshil21 · 2022-10-26T20:45:45Z

telegram/ext/filters.py

+    .. seealso:: `Types of Handlers <https://github.com/\
+        python-telegram-bot/python-telegram-bot/wiki/Types-of-Handlers>`_


not needed imo

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)

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 :)

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

harshil21

LGTM

Poolitzer

LGTM

lemontree210 added 15 commits October 23, 2022 20:52

feat(docs) add ..seealso:: links to "Your First Bot" in wiki

82674a2

feat(docs) add links to "Architecture" and pages mentioned there

b5a1117

feat(docs) add links to "Builder Pattern" wiki page

c4ccdc1

feat(docs) add links to "Types of Handlers" wiki page

256772a

fix(docs) make link text to Builder Battern unique

e028199

fix(docs) add link to Exceptions/Warnings/Logging wiki page

441e318

feat/fix(docs) add links to Concurrency wiki, fix link to Architecture

cfc3d94

feat(docs) add links to Notable Features wiki: "Filters" .. "Job Queue"

f61088b

fix(docs) add Updater.stop to run_polling to resolve conflict

eee0292

Merge branch 'doc-fixes' into docs-references-to-examples-and-wiki-3110

cd9268b

feat(docs) add links to "Arbitrary callback_data" wiki page

3594c99

feat(docs) add links to "Avoiding Flood limits" wiki page

8354b4b

feat(docs) add links to "Webhooks" wiki page

e810a0c

Merge remote-tracking branch 'origin/docs-references-to-examples-and-…

87aa42e

…wiki-3110' into docs-references-to-examples-and-wiki-3110 # Conflicts: # telegram/ext/_application.py

feat(docs) fix links to "Arbitrary callback_data" wiki page

c3e86b9

feat(docs) add links to echobot, timerbot and 2 conversationbots

82cbe69

Bibo-Joshi reviewed Oct 25, 2022

View reviewed changes

lemontree210 added 3 commits October 26, 2022 00:37

fix(docs) fix all remarks except adding Concurrency to all handlers

0b7ba85

feat(docs) add link to Concurrency wiki to all handlers

32a2a89

feat(docs) add links to examples

5c1a86b

Bibo-Joshi reviewed Oct 26, 2022

View reviewed changes

telegram/_chat.py Outdated Show resolved Hide resolved

telegram/ext/_callbackqueryhandler.py Outdated Show resolved Hide resolved

address comments: remove links to examples

c5bac06

harshil21 reviewed Oct 26, 2022

View reviewed changes

harshil21 added the documentation label Oct 26, 2022

harshil21 added this to the v20.0b1 milestone Oct 26, 2022

harshil21 added the hacktoberfest-accepted Label PRs with this so that Hacktoberfest counts them as valid label Oct 26, 2022

harshil21 mentioned this pull request Oct 30, 2022

[Documentation] Link to examples within a Example: block #3320

Closed

harshil21 approved these changes Oct 30, 2022

View reviewed changes

Poolitzer approved these changes Oct 31, 2022

View reviewed changes

Poolitzer linked an issue Oct 31, 2022 that may be closed by this pull request

[Documentation] Link to examples within a Example: block #3320

Closed

Poolitzer removed a link to an issue Oct 31, 2022

[Documentation] Link to examples within a Example: block #3320

Closed

harshil21 merged commit 985203d into python-telegram-bot:doc-fixes Oct 31, 2022

lemontree210 deleted the docs-references-to-examples-and-wiki-3110 branch October 31, 2022 09:14

Poolitzer mentioned this pull request Oct 31, 2022

Documentation Improvements #3214

Merged

11 tasks

github-actions bot locked and limited conversation to collaborators Nov 7, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add references to wiki #3306

Add references to wiki #3306

lemontree210 commented Oct 23, 2022 •

edited

lemontree210 commented Oct 25, 2022

Bibo-Joshi left a comment

lemontree210 commented Oct 25, 2022

lemontree210 commented Oct 26, 2022

lemontree210 commented Oct 26, 2022

harshil21 left a comment

harshil21 Oct 26, 2022

lemontree210 Oct 27, 2022

Bibo-Joshi Oct 29, 2022

harshil21 Oct 30, 2022

harshil21 left a comment

Poolitzer left a comment

		.. seealso:: `Types of Handlers <https://github.com/\
		python-telegram-bot/python-telegram-bot/wiki/Types-of-Handlers>`_

Add references to wiki #3306

Add references to wiki #3306

Conversation

lemontree210 commented Oct 23, 2022 • edited

lemontree210 commented Oct 25, 2022

Bibo-Joshi left a comment

Choose a reason for hiding this comment

lemontree210 commented Oct 25, 2022

lemontree210 commented Oct 26, 2022

lemontree210 commented Oct 26, 2022

harshil21 left a comment

Choose a reason for hiding this comment

harshil21 Oct 26, 2022

Choose a reason for hiding this comment

lemontree210 Oct 27, 2022

Choose a reason for hiding this comment

Bibo-Joshi Oct 29, 2022

Choose a reason for hiding this comment

harshil21 Oct 30, 2022

Choose a reason for hiding this comment

harshil21 left a comment

Choose a reason for hiding this comment

Poolitzer left a comment

Choose a reason for hiding this comment

lemontree210 commented Oct 23, 2022 •

edited