Title: behavior with the help function · Issue #279 · python/typing · GitHub
Open Graph Title: behavior with the help function · Issue #279 · python/typing
X Title: behavior with the help function · Issue #279 · python/typing
Description: I like the idea of type hint provided by this module, and I would like to use it more often but what stop me for doing so is the lost of information in the automatically generate documentation for the function I annotate using this modul...
Open Graph Description: I like the idea of type hint provided by this module, and I would like to use it more often but what stop me for doing so is the lost of information in the automatically generate documentation for ...
X Description: I like the idea of type hint provided by this module, and I would like to use it more often but what stop me for doing so is the lost of information in the automatically generate documentation for ...
Opengraph URL: https://github.com/python/typing/issues/279
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"behavior with the help function","articleBody":"I like the idea of type hint provided by this module, and I would like to use it more often but what stop me for doing so is the lost of information in the automatically generate documentation for the function I annotate using this module, take this for example\n\n```\nfrom typing import Iterator\ndef fib() -\u003e Iterator[int]:\n \"\"\"A generator of blah blah\"\"\"\n ...\n```\n\nwhen calling `help` in that function (or the little hint that pop up in the idle) I get the following\n\n```\n\u003e\u003e\u003e help(fib)\nHelp on function fib in module __main__:\n\nfib() -\u003e typing.Iterator\n A generator of blah blah\n\n\u003e\u003e\u003e \n```\n\nas you can see I lost information about `fib` as I clearly annotate it a iterator of int but that is not reflected in the help in any way as all the internal structure/details that I put in the annotations are lost. The same apply for all the others members of typing\n\nSo I would like to get from the above example the following output\n\n```\n\u003e\u003e\u003e help(fib)\nHelp on function fib in module __main__:\n\nfib() -\u003e Iterator[int]\n A generator of blah blah\n\n\u003e\u003e\u003e \n```\n\nwhich is more helpful and with just a glance I know what I am getting or need from/for the function.\n","author":{"url":"https://github.com/copperfield42","@type":"Person","name":"copperfield42"},"datePublished":"2016-09-06T19:58:09.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":2},"url":"https://github.com/279/typing/issues/279"}
| 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:e2ebe40a-62bb-70bf-5cc6-463d76e16f33 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 8190:7F1A9:24133D:30CA88:6A4D2B4F |
| html-safe-nonce | 7e08d62f638b99f9a846f04b784969067b3dd96105a0ceaa3277b5a34681a2f4 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4MTkwOjdGMUE5OjI0MTMzRDozMENBODg6NkE0RDJCNEYiLCJ2aXNpdG9yX2lkIjoiMzUyMTU3NDI5NzcyOTMxMzYxNSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 9d9b81e713b6f02cab741dec3abb4ae7f26c63dd5cedcb2940b7fde8dd424424 |
| hovercard-subject-tag | issue:175336848 |
| 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/python/typing/279/issue_layout |
| twitter:image | https://opengraph.githubassets.com/31b1306d5183f964360bd0740a60d1a575c48d5ce33187d66eeca0d17818ee44/python/typing/issues/279 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/31b1306d5183f964360bd0740a60d1a575c48d5ce33187d66eeca0d17818ee44/python/typing/issues/279 |
| og:image:alt | I like the idea of type hint provided by this module, and I would like to use it more often but what stop me for doing so is the lost of information in the automatically generate documentation for ... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | copperfield42 |
| hostname | github.com |
| expected-hostname | github.com |
| None | 92571a8944142227b7e19cd10918b1ddd06e5066c1ad5bc7e4769cf6140a87e6 |
| turbo-cache-control | no-preview |
| go-import | github.com/python/typing git https://github.com/python/typing.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 24604008 |
| octolytics-dimension-repository_nwo | python/typing |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 24604008 |
| octolytics-dimension-repository_network_root_nwo | python/typing |
| 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 | 93f17a978ee60bc4668e1d7b90e6bd2d622261fd |
| ui-target | canary-2 |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width