-
Notifications
You must be signed in to change notification settings - Fork 5.9k
Closed
Labels
ℹ️ good-first-issueinformation: good-first-issueinformation: good-first-issue⚙️ documentationaffected functionality: documentationaffected functionality: documentation
Description
It would be nice to add more cross-references to the documentation. This should help users to better understand "where is this used?"/"what is this relevant for?".
For this, we can use the sphinx directive .. seealso:: like done e.g. here.
Notable things that can be cross-referenced better include:
- point to shortcuts from the bot methods. e.g. point to
Message.reply_textfromBot.send_message, point toCallbackQuery.answerfromBot.answer_callback_queryand so on. - point to examples & wiki: All classes/arguments that are show cased in an example or explained in a wiki page should point to those. e.g.
JobQueueshould point totimerbotand the wiki page onJobQueue.Bot.arbitrary_callback_datashould point to the wiki page on arbitrary callback data and to thearbitrarycallbackbotexample. - for classes in tg.ext (and for
tg.Bot) point to attributes of that type: e.g.JobQueueshould point to{Application, CallbackContext}.job_queue,Botshould point to{Application, Updater, CallbackContext}.bot,CallbackDataCacheshould point toExtBot.callback_data_cache
Contributions in this direction are very welcome! They also don't have to cover everything classes at once - instead this can be done step by step. If you want to cover (parts of) this, please leave a comment below, so that we can avoid duplicate work.
PRs for this should be made against the doc-fixes branch. Please also check out the contribution guide, especially the part on how to build the documentation locally.
Metadata
Metadata
Assignees
Labels
ℹ️ good-first-issueinformation: good-first-issueinformation: good-first-issue⚙️ documentationaffected functionality: documentationaffected functionality: documentation