Title: change: Make signatures formatting more consistent? · Issue #193 · mkdocstrings/python · GitHub
Open Graph Title: change: Make signatures formatting more consistent? · Issue #193 · mkdocstrings/python
X Title: change: Make signatures formatting more consistent? · Issue #193 · mkdocstrings/python
Description: Reported on Matrix. One rather small nit with signatures, when using separate signatures formatted by Black, is that the formatting varies depending on how many arguments there are and how long they and their possible types and default v...
Open Graph Description: Reported on Matrix. One rather small nit with signatures, when using separate signatures formatted by Black, is that the formatting varies depending on how many arguments there are and how long the...
X Description: Reported on Matrix. One rather small nit with signatures, when using separate signatures formatted by Black, is that the formatting varies depending on how many arguments there are and how long the...
Opengraph URL: https://github.com/mkdocstrings/python/issues/193
X: @github
Domain: patch-diff.githubusercontent.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"change: Make signatures formatting more consistent?","articleBody":"Reported on Matrix.\r\n\r\n\u003e One rather small nit with signatures, when using separate signatures formatted by Black, is that the formatting varies depending on how many arguments there are and how long they and their possible types and default valus are. All these formats are possible:\r\n\r\n```python\r\ncompact(arg: int) -\u003e bool\r\n\r\nsemi_compact(\r\n first_arg: int, second_arg: int\r\n) -\u003e int\r\n\r\nverbose(\r\n first_arg: int = 1,\r\n second_arg: int = 2,\r\n third_arg: int = 3\r\n) -\u003e int\r\n```\r\n\r\n\u003e I undertand why the format changes and it isn't a big problem, but it is still somewhat confusing and inconsistent if two functions in same module have different signature formats. It would be great if there was a way to force the verbose style to be used always or, perhaps better, always when there's more than one parameter. Unless Black has a such configuration option this may be too hard to implement, though, and Black isn't known for supporting much configuration.","author":{"url":"https://github.com/pawamoy","@type":"Person","name":"pawamoy"},"datePublished":"2024-10-14T20:28:17.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":3},"url":"https://github.com/193/python/issues/193"}
| 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:14e17eb5-673d-6360-d663-12ffbd614e45 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 92D6:26E5F6:116161:188F83:696E3910 |
| html-safe-nonce | 31924a598be5715cf2bb1ae756f402945c4e473f29d1022748c72a981b13e097 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5MkQ2OjI2RTVGNjoxMTYxNjE6MTg4RjgzOjY5NkUzOTEwIiwidmlzaXRvcl9pZCI6IjgwNjczMjgxNTcyMTcwNzc1MjAiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 0939a23a934174401b4ebf4f09edfe036e3419bcbfb9c261844affc7d68e3f51 |
| hovercard-subject-tag | issue:2586979601 |
| 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/193/issue_layout |
| twitter:image | https://opengraph.githubassets.com/96cf516e71831ff2a65fd0b864f8ef7ede4805ab8b3d68c3713509209a9e1478/mkdocstrings/python/issues/193 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/96cf516e71831ff2a65fd0b864f8ef7ede4805ab8b3d68c3713509209a9e1478/mkdocstrings/python/issues/193 |
| og:image:alt | Reported on Matrix. One rather small nit with signatures, when using separate signatures formatted by Black, is that the formatting varies depending on how many arguments there are and how long the... |
| 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 | b39958d54b39d52b9fc890ff25687d2383a83e003512d4480499b2dbd046839f |
| 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 | fba10be4ea34590240b2f4a625fc807362c2d5b8 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width