Title: [Documentation] Add more cross-references · Issue #3110 · python-telegram-bot/python-telegram-bot · GitHub
Open Graph Title: [Documentation] Add more cross-references · Issue #3110 · python-telegram-bot/python-telegram-bot
X Title: [Documentation] Add more cross-references · Issue #3110 · python-telegram-bot/python-telegram-bot
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. her...
Open Graph 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 d...
X 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 ...
Opengraph URL: https://github.com/python-telegram-bot/python-telegram-bot/issues/3110
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[Documentation] Add more cross-references","articleBody":"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?\".\r\n\r\nFor this, we can use the sphinx directive `.. seealso::` like done e.g. [here](https://github.com/python-telegram-bot/python-telegram-bot/blob/67e7468366098f79cd2aa4f88b40e6e47d93ae5a/telegram/ext/_applicationbuilder.py#L332).\r\n\r\nNotable things that can be cross-referenced better include:\r\n\r\n* 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.\r\n* 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.\r\n* 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`\r\n\r\nContributions 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.\r\n\r\nPRs for this should be made against the `doc-fixes` branch. Please also check out the [contribution guide](https://docs.python-telegram-bot.org/en/v20.0a1/contributing.html), especially the part on how to [build the documentation locally](https://docs.python-telegram-bot.org/en/v20.0a1/contributing.html#documenting).","author":{"url":"https://github.com/Bibo-Joshi","@type":"Person","name":"Bibo-Joshi"},"datePublished":"2022-06-21T08:51:22Z","url":"https://github.com/python-telegram-bot/python-telegram-bot/issues/3110"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:4c17dcf9-09c7-fb59-51eb-c89326dd26f3 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | D35C:88BC0:7E31FF:9DE650:6B02541A |
| html-safe-nonce | 567d9265c10bdf3b10b30efe21a7688e8e1590b38764245018c362decd28d15c |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEMzVDOjg4QkMwOjdFMzFGRjo5REU2NTA6NkIwMjU0MUEiLCJ2aXNpdG9yX2lkIjoiMTQzNjk5NzgwNjM0MzAxNDY2IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 2efdfb8e51db4b789abaf713ad5e1808da1e1051a76a851090d40fac902de12f |
| hovercard-subject-tag | issue:1278116940 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python-telegram-bot/python-telegram-bot/3110/issue_layout |
| twitter:image | https://opengraph.githubassets.com/419c180cb1bc196831ee9232f856bfb129f535f387bbe5926de5543dd46caf8f/python-telegram-bot/python-telegram-bot/issues/3110 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/419c180cb1bc196831ee9232f856bfb129f535f387bbe5926de5543dd46caf8f/python-telegram-bot/python-telegram-bot/issues/3110 |
| og:image:alt | 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 d... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | Bibo-Joshi |
| hostname | github.com |
| expected-hostname | github.com |
| None | 87e774ee7c6b3bee0490394e4d3e57ec9dbc956f74b87ea685dc8996c1676456 |
| turbo-cache-control | no-preview |
| go-import | github.com/python-telegram-bot/python-telegram-bot git https://github.com/python-telegram-bot/python-telegram-bot.git |
| octolytics-dimension-user_id | 16178365 |
| octolytics-dimension-user_login | python-telegram-bot |
| octolytics-dimension-repository_id | 38696925 |
| octolytics-dimension-repository_nwo | python-telegram-bot/python-telegram-bot |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 38696925 |
| octolytics-dimension-repository_network_root_nwo | python-telegram-bot/python-telegram-bot |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 423dbb54c5e7bfecc838eb387c1435eb3d0e760d |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width