Skip to content

[Documentation] Add more cross-references #3110

@Bibo-Joshi

Description

@Bibo-Joshi

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_text from Bot.send_message, point to CallbackQuery.answer from Bot.answer_callback_query and 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. JobQueue should point to timerbot and the wiki page on JobQueue. Bot.arbitrary_callback_data should point to the wiki page on arbitrary callback data and to the arbitrarycallbackbot example.
  • for classes in tg.ext (and for tg.Bot) point to attributes of that type: e.g. JobQueue should point to {Application, CallbackContext}.job_queue, Bot should point to {Application, Updater, CallbackContext}.bot, CallbackDataCache should point to ExtBot.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

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions