René's URL Explorer Experiment


Title: bug: Typing.Overload from pyi file not showing in generated docs · Issue #182 · mkdocstrings/python · GitHub

Open Graph Title: bug: Typing.Overload from pyi file not showing in generated docs · Issue #182 · mkdocstrings/python

X Title: bug: Typing.Overload from pyi file not showing in generated docs · Issue #182 · mkdocstrings/python

Description: Description of the bug I have methods defined with @typing.overload but they are not showing up in the generated docs. Other methods show up fine, but not the overload ones. There are no warnings. I am using the insiders version of mkdoc...

Open Graph Description: Description of the bug I have methods defined with @typing.overload but they are not showing up in the generated docs. Other methods show up fine, but not the overload ones. There are no warnings. ...

X Description: Description of the bug I have methods defined with @typing.overload but they are not showing up in the generated docs. Other methods show up fine, but not the overload ones. There are no warnings. ...

Opengraph URL: https://github.com/mkdocstrings/python/issues/182

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"bug: Typing.Overload from pyi file not showing in generated docs","articleBody":"### Description of the bug\r\n\r\nI have methods defined with `@typing.overload` but they are not showing up in the generated docs. Other methods show up fine, but not the overload ones. There are no warnings. I am using the insiders version of mkdocstring-python and griffe\r\n\r\nMy docs are generated from definitions like this in my pyi file:\r\n\r\n```python\r\n@typing.overload\r\ndef add_column(\r\n    self, name: str, type: types.DataType, format: formats.DataFormat\r\n) -\u003e None:\r\n    \"\"\"\r\n    Add a new column to the data container\r\n    \"\"\"\r\n\r\n@typing.overload\r\ndef add_column(self, name: str, type: types.HumanType) -\u003e None:\r\n    \"\"\"\r\n    Add a new column to the data container\r\n    \"\"\"\r\n\r\n@typing.overload\r\ndef add_column(self, name: str, type: types.DataType) -\u003e None:\r\n    \"\"\"\r\n    Add a new column to the data container\r\n    \"\"\"\r\n```\r\n\r\nNOTE: There is not any backing .py file because this is a wrapper around a c++ python module. So the mkdocstrings generation is purely going against the .pyi files.\r\n\r\n\r\n### To Reproduce\r\n\r\n.pyi file with the definitions above\r\n\r\n### Expected behavior\r\n\r\nExpect the overloaded methods to show in the docs\r\n\r\n### Environment information\r\n\r\n- __System__: Linux-6.6.31-linuxkit-aarch64-with\r\n- __Python__: cpython 3.11.9 (/usr/local/bin/python)\r\n- __Environment variables__:\r\n- __Installed packages__:\r\n  - `mkdocs` v1.6.0\r\n  - `mkdocstrings` v0.25.2\r\n  - `mkdocstrings-python` v1.10.8.1.8.3\r\n  - `griffe` v0.49.0.1.2.1.dev2+g5d4e082\r\n\r\n\r\n### Additional context\r\n\u003c!-- Add any other relevant context about the problem here,\r\n     like links to other issues or pull requests, screenshots, etc.\r\n--\u003e\r\n","author":{"url":"https://github.com/nvoxland-al","@type":"Person","name":"nvoxland-al"},"datePublished":"2024-08-20T15:48:14.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":14},"url":"https://github.com/182/python/issues/182"}

route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:73d771a6-11fe-bcfe-d96a-db0c1a51816c
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-id82AC:DE287:278F440:342BD7B:696B2679
html-safe-noncefd090e941e240c1bf30bbd426b31272e863f9d7f6d2d18ab82fed16b907c8366
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4MkFDOkRFMjg3OjI3OEY0NDA6MzQyQkQ3Qjo2OTZCMjY3OSIsInZpc2l0b3JfaWQiOiI4NzIxNTYyNDI2NDI0MzcwODA5IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmac2d8d1296b8a55a27b2afad2b5be8d5f6ad5b5507bdf2bd5ab8bb89ef362b93bb
hovercard-subject-tagissue:2475981805
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/mkdocstrings/python/182/issue_layout
twitter:imagehttps://opengraph.githubassets.com/a61e4188c31b0c5ab1dc09bc1a1f073553cc33fa23567db9e415befe6947d452/mkdocstrings/python/issues/182
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/a61e4188c31b0c5ab1dc09bc1a1f073553cc33fa23567db9e415befe6947d452/mkdocstrings/python/issues/182
og:image:altDescription of the bug I have methods defined with @typing.overload but they are not showing up in the generated docs. Other methods show up fine, but not the overload ones. There are no warnings. ...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamenvoxland-al
hostnamegithub.com
expected-hostnamegithub.com
None5f99f7c1d70f01da5b93e5ca90303359738944d8ab470e396496262c66e60b8d
turbo-cache-controlno-preview
go-importgithub.com/mkdocstrings/python git https://github.com/mkdocstrings/python.git
octolytics-dimension-user_id75664361
octolytics-dimension-user_loginmkdocstrings
octolytics-dimension-repository_id422878404
octolytics-dimension-repository_nwomkdocstrings/python
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id422878404
octolytics-dimension-repository_network_root_nwomkdocstrings/python
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
release82560a55c6b2054555076f46e683151ee28a19bc
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/mkdocstrings/python/issues/182#start-of-content
https://github.com/
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmkdocstrings%2Fpython%2Fissues%2F182
GitHub CopilotWrite better code with AIhttps://github.com/features/copilot
GitHub SparkBuild and deploy intelligent appshttps://github.com/features/spark
GitHub ModelsManage and compare promptshttps://github.com/features/models
MCP RegistryNewIntegrate external toolshttps://github.com/mcp
ActionsAutomate any workflowhttps://github.com/features/actions
CodespacesInstant dev environmentshttps://github.com/features/codespaces
IssuesPlan and track workhttps://github.com/features/issues
Code ReviewManage code changeshttps://github.com/features/code-review
GitHub Advanced SecurityFind and fix vulnerabilitieshttps://github.com/security/advanced-security
Code securitySecure your code as you buildhttps://github.com/security/advanced-security/code-security
Secret protectionStop leaks before they starthttps://github.com/security/advanced-security/secret-protection
Why GitHubhttps://github.com/why-github
Documentationhttps://docs.github.com
Bloghttps://github.blog
Changeloghttps://github.blog/changelog
Marketplacehttps://github.com/marketplace
View all featureshttps://github.com/features
Enterpriseshttps://github.com/enterprise
Small and medium teamshttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
App Modernizationhttps://github.com/solutions/use-case/app-modernization
DevSecOpshttps://github.com/solutions/use-case/devsecops
DevOpshttps://github.com/solutions/use-case/devops
CI/CDhttps://github.com/solutions/use-case/ci-cd
View all use caseshttps://github.com/solutions/use-case
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
View all industrieshttps://github.com/solutions/industry
View all solutionshttps://github.com/solutions
AIhttps://github.com/resources/articles?topic=ai
Software Developmenthttps://github.com/resources/articles?topic=software-development
DevOpshttps://github.com/resources/articles?topic=devops
Securityhttps://github.com/resources/articles?topic=security
View all topicshttps://github.com/resources/articles
Customer storieshttps://github.com/customer-stories
Events & webinarshttps://github.com/resources/events
Ebooks & reportshttps://github.com/resources/whitepapers
Business insightshttps://github.com/solutions/executive-insights
GitHub Skillshttps://skills.github.com
Documentationhttps://docs.github.com
Customer supporthttps://support.github.com
Community forumhttps://github.com/orgs/community/discussions
Trust centerhttps://github.com/trust-center
Partnershttps://github.com/partners
GitHub SponsorsFund open source developershttps://github.com/sponsors
Security Labhttps://securitylab.github.com
Maintainer Communityhttps://maintainers.github.com
Acceleratorhttps://github.com/accelerator
Archive Programhttps://archiveprogram.github.com
Topicshttps://github.com/topics
Trendinghttps://github.com/trending
Collectionshttps://github.com/collections
Enterprise platformAI-powered developer platformhttps://github.com/enterprise
GitHub Advanced SecurityEnterprise-grade security featureshttps://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/premium-support
Pricinghttps://github.com/pricing
Search syntax tipshttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
documentationhttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmkdocstrings%2Fpython%2Fissues%2F182
Sign up https://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=mkdocstrings%2Fpython
Reloadhttps://github.com/mkdocstrings/python/issues/182
Reloadhttps://github.com/mkdocstrings/python/issues/182
Reloadhttps://github.com/mkdocstrings/python/issues/182
mkdocstrings https://github.com/mkdocstrings
pythonhttps://github.com/mkdocstrings/python
Please reload this pagehttps://github.com/mkdocstrings/python/issues/182
Notifications https://github.com/login?return_to=%2Fmkdocstrings%2Fpython
Fork 52 https://github.com/login?return_to=%2Fmkdocstrings%2Fpython
Star 259 https://github.com/login?return_to=%2Fmkdocstrings%2Fpython
Code https://github.com/mkdocstrings/python
Issues 10 https://github.com/mkdocstrings/python/issues
Pull requests 0 https://github.com/mkdocstrings/python/pulls
Discussions https://github.com/mkdocstrings/python/discussions
Actions https://github.com/mkdocstrings/python/actions
Security Uh oh! There was an error while loading. Please reload this page. https://github.com/mkdocstrings/python/security
Please reload this pagehttps://github.com/mkdocstrings/python/issues/182
Insights https://github.com/mkdocstrings/python/pulse
Code https://github.com/mkdocstrings/python
Issues https://github.com/mkdocstrings/python/issues
Pull requests https://github.com/mkdocstrings/python/pulls
Discussions https://github.com/mkdocstrings/python/discussions
Actions https://github.com/mkdocstrings/python/actions
Security https://github.com/mkdocstrings/python/security
Insights https://github.com/mkdocstrings/python/pulse
New issuehttps://github.com/login?return_to=https://github.com/mkdocstrings/python/issues/182
New issuehttps://github.com/login?return_to=https://github.com/mkdocstrings/python/issues/182
bug: Typing.Overload from pyi file not showing in generated docshttps://github.com/mkdocstrings/python/issues/182#top
https://github.com/pawamoy
griffe extensionCan be solved with a Griffe extensionhttps://github.com/mkdocstrings/python/issues?q=state%3Aopen%20label%3A%22griffe%20extension%22
https://github.com/nvoxland-al
https://github.com/nvoxland-al
nvoxland-alhttps://github.com/nvoxland-al
on Aug 20, 2024https://github.com/mkdocstrings/python/issues/182#issue-2475981805
pawamoyhttps://github.com/pawamoy
griffe extensionCan be solved with a Griffe extensionhttps://github.com/mkdocstrings/python/issues?q=state%3Aopen%20label%3A%22griffe%20extension%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.