Title: feature: Option to hide implementation signature in case of overloads · Issue #213 · mkdocstrings/python · GitHub
Open Graph Title: feature: Option to hide implementation signature in case of overloads · Issue #213 · mkdocstrings/python
X Title: feature: Option to hide implementation signature in case of overloads · Issue #213 · mkdocstrings/python
Description: Is your feature request related to a problem? Please describe. See #182 (comment). Implementations often combine all parameters and their types together and can be hard to read, compared to overloads with their clean signatures. Describe...
Open Graph Description: Is your feature request related to a problem? Please describe. See #182 (comment). Implementations often combine all parameters and their types together and can be hard to read, compared to overloa...
X Description: Is your feature request related to a problem? Please describe. See #182 (comment). Implementations often combine all parameters and their types together and can be hard to read, compared to overloa...
Opengraph URL: https://github.com/mkdocstrings/python/issues/213
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"feature: Option to hide implementation signature in case of overloads","articleBody":"### Is your feature request related to a problem? Please describe.\r\nSee https://github.com/mkdocstrings/python/issues/182#issuecomment-2356467113. Implementations often combine all parameters and their types together and can be hard to read, compared to overloads with their clean signatures.\r\n\r\n### Describe the solution you'd like\r\nAn option to hide the implementation signature and only render the overloads.\r\n\r\nWith separated signatures, easy, just render the overloads, then the docstring of the implementation (or something else depending on how overloads rendering evolves).\r\n\r\nWith signatures in heading, just don't render the implementation signature in the heading.\r\n\r\n### Describe alternatives you've considered\r\nOverriding templates, but our templates and their blocks still not allow lightweight customization. They often require to copy-paste big blocks of Jinja code, which in the long-term is not great for maintenance (no easy way to get recent updates while maintaining your own changes).\r\n\r\n### Additional context\r\n/","author":{"url":"https://github.com/pawamoy","@type":"Person","name":"pawamoy"},"datePublished":"2024-12-03T16:48:47.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":2},"url":"https://github.com/213/python/issues/213"}
| 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:324b1e98-3134-ac3b-61d9-e88247885ffe |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 8926:388B78:10806FE:15620A8:696B0E79 |
| html-safe-nonce | 893e2bfb470fff03a37f2aad61c6473351c6ce2043dc02a1f301c556a54fa425 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4OTI2OjM4OEI3ODoxMDgwNkZFOjE1NjIwQTg6Njk2QjBFNzkiLCJ2aXNpdG9yX2lkIjoiMjQ1ODUyNjYxNDYwMTc2NTA1IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 839f048d55ff7f2b5c75b629af392badd10a17f05f359687a5cc72f2af8081b6 |
| hovercard-subject-tag | issue:2715523903 |
| 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/mkdocstrings/python/213/issue_layout |
| twitter:image | https://opengraph.githubassets.com/2c22b6ed0c880fcb3128f10f48493b3564a02dbf60998f17bc65f1e6deedb245/mkdocstrings/python/issues/213 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/2c22b6ed0c880fcb3128f10f48493b3564a02dbf60998f17bc65f1e6deedb245/mkdocstrings/python/issues/213 |
| og:image:alt | Is your feature request related to a problem? Please describe. See #182 (comment). Implementations often combine all parameters and their types together and can be hard to read, compared to overloa... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | pawamoy |
| hostname | github.com |
| expected-hostname | github.com |
| None | 5f99f7c1d70f01da5b93e5ca90303359738944d8ab470e396496262c66e60b8d |
| turbo-cache-control | no-preview |
| go-import | github.com/mkdocstrings/python git https://github.com/mkdocstrings/python.git |
| octolytics-dimension-user_id | 75664361 |
| octolytics-dimension-user_login | mkdocstrings |
| octolytics-dimension-repository_id | 422878404 |
| octolytics-dimension-repository_nwo | mkdocstrings/python |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 422878404 |
| octolytics-dimension-repository_network_root_nwo | mkdocstrings/python |
| 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 | 82560a55c6b2054555076f46e683151ee28a19bc |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width