René's URL Explorer Experiment


Title: bug: Class init parameter name disappears from attribute docstring using `separate_signature` · Issue #215 · mkdocstrings/python · GitHub

Open Graph Title: bug: Class init parameter name disappears from attribute docstring using `separate_signature` · Issue #215 · mkdocstrings/python

X Title: bug: Class init parameter name disappears from attribute docstring using `separate_signature` · Issue #215 · mkdocstrings/python

Description: Description of the bug When calling a method on an input argument to a class __init__ while having separate_signature: true, the parameter name disappears from the rendered instance attribute docstring, leaving only the attribute name an...

Open Graph Description: Description of the bug When calling a method on an input argument to a class __init__ while having separate_signature: true, the parameter name disappears from the rendered instance attribute docst...

X Description: Description of the bug When calling a method on an input argument to a class __init__ while having separate_signature: true, the parameter name disappears from the rendered instance attribute docst...

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

X: @github

direct link

Domain: patch-diff.githubusercontent.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"bug: Class init parameter name disappears from attribute docstring using `separate_signature`","articleBody":"### Description of the bug\r\nWhen calling a method on an input argument to a class `__init__` while having `separate_signature: true`, the parameter name disappears from the rendered instance attribute docstring, leaving only the attribute name and the method called on the input argument.\r\n\r\n### To Reproduce\r\n\u003cdetails\u003e\r\n\r\n```console\r\npython -m venv .venv\r\n. .venv/bin/activate\r\npip install mkdocstrings-python\r\npython\r\n```\r\n\r\n```yaml\r\n# mkdocs.yml\r\nsite_name: test-site\r\nplugins:\r\n  - mkdocstrings:\r\n      default_handler: python\r\n      handlers:\r\n        python:\r\n          options:\r\n            separate_signature: true\r\n```\r\n\r\n```markdown\r\n\u003c!-- test.md --\u003e\r\n::: test\r\n```\r\n\r\n```python\r\n# test.py\r\n\r\nclass SomeClass:\r\n    \"\"\"This is a class that does something.\"\"\"\r\n\r\n    def __init__(self, some_float: float) -\u003e None:\r\n        self.as_hex = some_float.hex()\r\n        \"\"\"The hex value of the input float.\"\"\"\r\n```\r\n\u003c/details\u003e\r\n\r\n### Expected behavior\r\n![image](https://github.com/user-attachments/assets/06098a37-ff7f-4c42-a457-50ecbf3efd9d)\r\n\r\nI expect the rendered docstring for the `as_hex` instance attribute to say `as_hex = some_float.hex()`.\r\n\r\n### Actual behavior\r\n![image](https://github.com/user-attachments/assets/891226c5-380c-4bce-a933-fa299e8aeda5)\r\n\r\nWith `separate_signature: true`, the `some_float` part disappears, and what is rendered is only `as_hex = hex()`.\r\n\r\n\r\n### Environment information\r\n```bash\r\npython -m mkdocstrings_handlers.python.debug  # | xclip -selection clipboard\r\n```\r\n\r\n- __System__: Linux-6.8.0-49-generic-x86_64-with-glibc2.39\r\n- __Python__: cpython 3.13.1 (/home/stefan/test-mkdocstrings/.venv/bin/python)\r\n- __Environment variables__:\r\n- __Installed packages__:\r\n  - `mkdocs` v1.6.1\r\n  - `mkdocstrings` v0.27.0\r\n  - `mkdocstrings-python` v1.12.2\r\n  - `griffe` v1.5.1","author":{"url":"https://github.com/connesy","@type":"Person","name":"connesy"},"datePublished":"2024-12-11T13:45:41.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":6},"url":"https://github.com/215/python/issues/215"}

route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:d802898d-5309-b26d-4599-1236be0828e8
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idACD0:3D10A9:160B0F:1D6634:696E6C6E
html-safe-nonce8694aaa6e852efb5b6362c00ca6588e99ff407b18d25849cfc421e195b54af21
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBQ0QwOjNEMTBBOToxNjBCMEY6MUQ2NjM0OjY5NkU2QzZFIiwidmlzaXRvcl9pZCI6Ijc2NTE0MzM2MzYyODgxNjI5MjYiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac7723bfba815f293070fe2b614c322a55d792b6bb367a0d8371d1ddd64cf30dec
hovercard-subject-tagissue:2733025198
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/215/issue_layout
twitter:imagehttps://opengraph.githubassets.com/ac9d1242a5fb19636e127f26338d88544a000281d4828f14f8091fdf2013b529/mkdocstrings/python/issues/215
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/ac9d1242a5fb19636e127f26338d88544a000281d4828f14f8091fdf2013b529/mkdocstrings/python/issues/215
og:image:altDescription of the bug When calling a method on an input argument to a class __init__ while having separate_signature: true, the parameter name disappears from the rendered instance attribute docst...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameconnesy
hostnamegithub.com
expected-hostnamegithub.com
Nonedd24262d9e4947a6c63df018b01e9a6da49caaf8259148a56a04b665d15d66b3
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
release307ab96ec5f21762ff6c530a60b1ef6b1e74dd5a
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://patch-diff.githubusercontent.com/mkdocstrings/python/issues/215#start-of-content
https://patch-diff.githubusercontent.com/
Sign in https://patch-diff.githubusercontent.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmkdocstrings%2Fpython%2Fissues%2F215
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://patch-diff.githubusercontent.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmkdocstrings%2Fpython%2Fissues%2F215
Sign up https://patch-diff.githubusercontent.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://patch-diff.githubusercontent.com/mkdocstrings/python/issues/215
Reloadhttps://patch-diff.githubusercontent.com/mkdocstrings/python/issues/215
Reloadhttps://patch-diff.githubusercontent.com/mkdocstrings/python/issues/215
mkdocstrings https://patch-diff.githubusercontent.com/mkdocstrings
pythonhttps://patch-diff.githubusercontent.com/mkdocstrings/python
Please reload this pagehttps://patch-diff.githubusercontent.com/mkdocstrings/python/issues/215
Notifications https://patch-diff.githubusercontent.com/login?return_to=%2Fmkdocstrings%2Fpython
Fork 52 https://patch-diff.githubusercontent.com/login?return_to=%2Fmkdocstrings%2Fpython
Star 259 https://patch-diff.githubusercontent.com/login?return_to=%2Fmkdocstrings%2Fpython
Code https://patch-diff.githubusercontent.com/mkdocstrings/python
Issues 10 https://patch-diff.githubusercontent.com/mkdocstrings/python/issues
Pull requests 0 https://patch-diff.githubusercontent.com/mkdocstrings/python/pulls
Discussions https://patch-diff.githubusercontent.com/mkdocstrings/python/discussions
Actions https://patch-diff.githubusercontent.com/mkdocstrings/python/actions
Security Uh oh! There was an error while loading. Please reload this page. https://patch-diff.githubusercontent.com/mkdocstrings/python/security
Please reload this pagehttps://patch-diff.githubusercontent.com/mkdocstrings/python/issues/215
Insights https://patch-diff.githubusercontent.com/mkdocstrings/python/pulse
Code https://patch-diff.githubusercontent.com/mkdocstrings/python
Issues https://patch-diff.githubusercontent.com/mkdocstrings/python/issues
Pull requests https://patch-diff.githubusercontent.com/mkdocstrings/python/pulls
Discussions https://patch-diff.githubusercontent.com/mkdocstrings/python/discussions
Actions https://patch-diff.githubusercontent.com/mkdocstrings/python/actions
Security https://patch-diff.githubusercontent.com/mkdocstrings/python/security
Insights https://patch-diff.githubusercontent.com/mkdocstrings/python/pulse
New issuehttps://patch-diff.githubusercontent.com/login?return_to=https://github.com/mkdocstrings/python/issues/215
New issuehttps://patch-diff.githubusercontent.com/login?return_to=https://github.com/mkdocstrings/python/issues/215
bug: Class init parameter name disappears from attribute docstring using separate_signaturehttps://patch-diff.githubusercontent.com/mkdocstrings/python/issues/215#top
https://patch-diff.githubusercontent.com/pawamoy
configRelated to configuration optionshttps://github.com/mkdocstrings/python/issues?q=state%3Aopen%20label%3A%22config%22
refactorChange suggestion, not a bug nor a feature.https://github.com/mkdocstrings/python/issues?q=state%3Aopen%20label%3A%22refactor%22
templatesJinja templateshttps://github.com/mkdocstrings/python/issues?q=state%3Aopen%20label%3A%22templates%22
https://github.com/connesy
https://github.com/connesy
connesyhttps://github.com/connesy
on Dec 11, 2024https://github.com/mkdocstrings/python/issues/215#issue-2733025198
https://private-user-images.githubusercontent.com/13164166/394768190-06098a37-ff7f-4c42-a457-50ecbf3efd9d.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Njg4NDQ2OTgsIm5iZiI6MTc2ODg0NDM5OCwicGF0aCI6Ii8xMzE2NDE2Ni8zOTQ3NjgxOTAtMDYwOThhMzctZmY3Zi00YzQyLWE0NTctNTBlY2JmM2VmZDlkLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjAxMTklMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwMTE5VDE3Mzk1OFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTk5OTE3OTIzZjlkNGUxNTIwYzk3NTY2MjJiMGYxOTRlZjlmODA1NzcwZjZmYmFkOTFhNzljZTFhNGZjNzAyM2UmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.-PvBp9elqldXpe2X9lga_pFgMvLNiGgKgMLGTLSOODo
https://private-user-images.githubusercontent.com/13164166/394768253-891226c5-380c-4bce-a933-fa299e8aeda5.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Njg4NDQ2OTgsIm5iZiI6MTc2ODg0NDM5OCwicGF0aCI6Ii8xMzE2NDE2Ni8zOTQ3NjgyNTMtODkxMjI2YzUtMzgwYy00YmNlLWE5MzMtZmEyOTllOGFlZGE1LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjAxMTklMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwMTE5VDE3Mzk1OFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWE1MDE1YWUwNjJkYmUxODY3NWRlYmYxMTg4NmI3ODg2MmE1ZGQyYjk3YTQ1N2QzODZmNjg1OTlkODk1YTg0ZGImWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.kMU5pLJw2_H4qjdmRFYbTxN9PDZ8AlyalVv2Zx64N9c
pawamoyhttps://patch-diff.githubusercontent.com/pawamoy
configRelated to configuration optionshttps://github.com/mkdocstrings/python/issues?q=state%3Aopen%20label%3A%22config%22
refactorChange suggestion, not a bug nor a feature.https://github.com/mkdocstrings/python/issues?q=state%3Aopen%20label%3A%22refactor%22
templatesJinja templateshttps://github.com/mkdocstrings/python/issues?q=state%3Aopen%20label%3A%22templates%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.