René's URL Explorer Experiment


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

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@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-profiling0
react-import-mapreact,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-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:4c17dcf9-09c7-fb59-51eb-c89326dd26f3
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idD35C:88BC0:7E31FF:9DE650:6B02541A
html-safe-nonce567d9265c10bdf3b10b30efe21a7688e8e1590b38764245018c362decd28d15c
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEMzVDOjg4QkMwOjdFMzFGRjo5REU2NTA6NkIwMjU0MUEiLCJ2aXNpdG9yX2lkIjoiMTQzNjk5NzgwNjM0MzAxNDY2IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmac2efdfb8e51db4b789abaf713ad5e1808da1e1051a76a851090d40fac902de12f
hovercard-subject-tagissue:1278116940
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python-telegram-bot/python-telegram-bot/3110/issue_layout
twitter:imagehttps://opengraph.githubassets.com/419c180cb1bc196831ee9232f856bfb129f535f387bbe5926de5543dd46caf8f/python-telegram-bot/python-telegram-bot/issues/3110
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/419c180cb1bc196831ee9232f856bfb129f535f387bbe5926de5543dd46caf8f/python-telegram-bot/python-telegram-bot/issues/3110
og:image:altIt 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:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameBibo-Joshi
hostnamegithub.com
expected-hostnamegithub.com
None87e774ee7c6b3bee0490394e4d3e57ec9dbc956f74b87ea685dc8996c1676456
turbo-cache-controlno-preview
go-importgithub.com/python-telegram-bot/python-telegram-bot git https://github.com/python-telegram-bot/python-telegram-bot.git
octolytics-dimension-user_id16178365
octolytics-dimension-user_loginpython-telegram-bot
octolytics-dimension-repository_id38696925
octolytics-dimension-repository_nwopython-telegram-bot/python-telegram-bot
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id38696925
octolytics-dimension-repository_network_root_nwopython-telegram-bot/python-telegram-bot
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release423dbb54c5e7bfecc838eb387c1435eb3d0e760d
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/python-telegram-bot/python-telegram-bot/issues/3110#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython-telegram-bot%2Fpython-telegram-bot%2Fissues%2F3110
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython-telegram-bot%2Fpython-telegram-bot%2Fissues%2F3110
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=python-telegram-bot%2Fpython-telegram-bot
Reloadhttps://github.com/python-telegram-bot/python-telegram-bot/issues/3110
Reloadhttps://github.com/python-telegram-bot/python-telegram-bot/issues/3110
Reloadhttps://github.com/python-telegram-bot/python-telegram-bot/issues/3110
python-telegram-bothttps://github.com/python-telegram-bot
python-telegram-bothttps://github.com/python-telegram-bot/python-telegram-bot
Codehttps://github.com/python-telegram-bot/python-telegram-bot
Issues23 (23)https://github.com/python-telegram-bot/python-telegram-bot/issues
Pull requests19 (19)https://github.com/python-telegram-bot/python-telegram-bot/pulls
Discussionshttps://github.com/python-telegram-bot/python-telegram-bot/discussions
Actionshttps://github.com/python-telegram-bot/python-telegram-bot/actions
Projectshttps://github.com/python-telegram-bot/python-telegram-bot/projects
Wikihttps://github.com/python-telegram-bot/python-telegram-bot/wiki
Security and qualityhttps://github.com/python-telegram-bot/python-telegram-bot/security
Insightshttps://github.com/python-telegram-bot/python-telegram-bot/insights
https://github.com/python-telegram-bot/python-telegram-bot
New issuehttps://github.com/login?return_to=https://github.com/python-telegram-bot/python-telegram-bot/issues/3110
New issuehttps://github.com/login?return_to=https://github.com/python-telegram-bot/python-telegram-bot/issues/3110
[Documentation] Add more cross-referenceshttps://github.com/python-telegram-bot/python-telegram-bot/issues/3110#top
ℹ️ good-first-issueinformation: good-first-issuehttps://github.com/python-telegram-bot/python-telegram-bot/issues?q=state%3Aopen%20label%3A%22%E2%84%B9%EF%B8%8F%20good-first-issue%22
⚙️ documentationaffected functionality: documentationhttps://github.com/python-telegram-bot/python-telegram-bot/issues?q=state%3Aopen%20label%3A%22%E2%9A%99%EF%B8%8F%20documentation%22
https://github.com/Bibo-Joshi
Bibo-Joshihttps://github.com/Bibo-Joshi
on Jun 21, 2022https://github.com/python-telegram-bot/python-telegram-bot/issues/3110#issue-1278116940
herehttps://github.com/python-telegram-bot/python-telegram-bot/blob/67e7468366098f79cd2aa4f88b40e6e47d93ae5a/telegram/ext/_applicationbuilder.py#L332
contribution guidehttps://docs.python-telegram-bot.org/en/v20.0a1/contributing.html
build the documentation locallyhttps://docs.python-telegram-bot.org/en/v20.0a1/contributing.html#documenting
Bibo-Joshihttps://github.com/Bibo-Joshi
ℹ️ good-first-issueinformation: good-first-issuehttps://github.com/python-telegram-bot/python-telegram-bot/issues?q=state%3Aopen%20label%3A%22%E2%84%B9%EF%B8%8F%20good-first-issue%22
⚙️ documentationaffected functionality: documentationhttps://github.com/python-telegram-bot/python-telegram-bot/issues?q=state%3Aopen%20label%3A%22%E2%9A%99%EF%B8%8F%20documentation%22
on Jun 21, 2022https://github.com/python-telegram-bot/python-telegram-bot/issues/3110#event-6845454212
https://github.com/clot27
clot27https://github.com/clot27
on Jun 22, 2022https://github.com/python-telegram-bot/python-telegram-bot/issues/3110#issuecomment-1163489947
https://github.com/Bibo-Joshi
Bibo-Joshihttps://github.com/Bibo-Joshi
on Jun 22, 2022https://github.com/python-telegram-bot/python-telegram-bot/issues/3110#issuecomment-1163539257
https://github.com/clot27
clot27https://github.com/clot27
on Jun 23, 2022https://github.com/python-telegram-bot/python-telegram-bot/issues/3110#issuecomment-1164058821
Bibo-Joshihttps://github.com/Bibo-Joshi
hacktoberfesthttps://github.com/python-telegram-bot/python-telegram-bot/issues?q=state%3Aopen%20label%3A%22hacktoberfest%22
on Sep 24, 2022https://github.com/python-telegram-bot/python-telegram-bot/issues/3110#event-7451464998
https://github.com/lemontree210
lemontree210https://github.com/lemontree210
on Oct 23, 2022https://github.com/python-telegram-bot/python-telegram-bot/issues/3110#issuecomment-1288095815
https://github.com/Bibo-Joshi
Bibo-Joshihttps://github.com/Bibo-Joshi
on Oct 23, 2022https://github.com/python-telegram-bot/python-telegram-bot/issues/3110#issuecomment-1288109483
harshil21https://github.com/harshil21
hacktoberfesthttps://github.com/python-telegram-bot/python-telegram-bot/issues?q=state%3Aopen%20label%3A%22hacktoberfest%22
on Nov 5, 2022https://github.com/python-telegram-bot/python-telegram-bot/issues/3110#event-7745551168
https://github.com/lemontree210
lemontree210https://github.com/lemontree210
on Nov 29, 2022https://github.com/python-telegram-bot/python-telegram-bot/issues/3110#issuecomment-1330851633
https://github.com/Bibo-Joshi
Bibo-Joshihttps://github.com/Bibo-Joshi
on Dec 3, 2022https://github.com/python-telegram-bot/python-telegram-bot/issues/3110#issuecomment-1336149086
Bibo-Joshihttps://github.com/Bibo-Joshi
completedhttps://github.com/python-telegram-bot/python-telegram-bot/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
on Dec 3, 2022https://github.com/python-telegram-bot/python-telegram-bot/issues/3110#event-7946130259
github-actionshttps://github.com/apps/github-actions
on Dec 10, 2022https://github.com/python-telegram-bot/python-telegram-bot/issues/3110#event-8005317037
Sign up for freehttps://github.com/signup?return_to=https://github.com/python-telegram-bot/python-telegram-bot/issues/3110
Sign in to commenthttps://github.com/login?return_to=https://github.com/python-telegram-bot/python-telegram-bot/issues/3110
ℹ️ good-first-issueinformation: good-first-issuehttps://github.com/python-telegram-bot/python-telegram-bot/issues?q=state%3Aopen%20label%3A%22%E2%84%B9%EF%B8%8F%20good-first-issue%22
⚙️ documentationaffected functionality: documentationhttps://github.com/python-telegram-bot/python-telegram-bot/issues?q=state%3Aopen%20label%3A%22%E2%9A%99%EF%B8%8F%20documentation%22
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.