Title: We need a policy for undocumented attributes · Issue #1902 · python/typeshed · GitHub
Open Graph Title: We need a policy for undocumented attributes · Issue #1902 · python/typeshed
X Title: We need a policy for undocumented attributes · Issue #1902 · python/typeshed
Description: In the past week alone I've seen several issues where well-meaning contributors wanted to add undocumented attributes to typeshed: #1884 #1885 #1898 #1901 I think we should have a standard policy on these. I know in the past we've someti...
Open Graph Description: In the past week alone I've seen several issues where well-meaning contributors wanted to add undocumented attributes to typeshed: #1884 #1885 #1898 #1901 I think we should have a standard policy o...
X Description: In the past week alone I've seen several issues where well-meaning contributors wanted to add undocumented attributes to typeshed: #1884 #1885 #1898 #1901 I think we should have a standard poli...
Opengraph URL: https://github.com/python/typeshed/issues/1902
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"We need a policy for undocumented attributes","articleBody":"In the past week alone I've seen several issues where well-meaning contributors wanted to add undocumented attributes to typeshed:\r\n\r\n- https://github.com/python/typeshed/pull/1884\r\n- https://github.com/python/typeshed/pull/1885\r\n- https://github.com/python/typeshed/pull/1898\r\n- https://github.com/python/typeshed/issues/1901\r\n\r\nI think we should have a standard policy on these. I know in the past we've sometimes added such attributes, with the argument that there's existing working code that uses them. But AFAIK there's no other tool that is capable of flagging the use of undocumented attributes, so I'm kind of leaning towards seeing this as a valuable service mypy (or rather, typeshed) provides, rather than a deficiency in the stubs. For example, if we were to add these attributes to the stubs, IDEs like PyCharm would start suggesting auto-completion for undocumented attributes, which I definitely think is a bad idea. If there's something that's commonly used, it should just be included in the docs first -- the process for that is clear (file an issue on bugs.python.org).","author":{"url":"https://github.com/gvanrossum","@type":"Person","name":"gvanrossum"},"datePublished":"2018-02-19T22:21:56Z","url":"https://github.com/python/typeshed/issues/1902"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| 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:5b0b6b0c-18e7-4df2-fac5-e10efac9cecf |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 9E20:1756E4:1E71EC0:2837113:6B004368 |
| html-safe-nonce | 9222eead28e528e3826d4b81fcd69eb1f892934cbf8220dbad34dcb7b0c6845c |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5RTIwOjE3NTZFNDoxRTcxRUMwOjI4MzcxMTM6NkIwMDQzNjgiLCJ2aXNpdG9yX2lkIjoiMjMzNTQ0MDgzMzIzNjQ1MjIwMCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 52e328b7df725ef45be2bc53d778f64a47a6133d8a0e10486bbe9aba6d17feec |
| hovercard-subject-tag | issue:298416346 |
| 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/typeshed/1902/issue_layout |
| twitter:image | https://opengraph.githubassets.com/7768459e7533d6b361120b1356df16c1b58fd94b4054963b6453f8c154124d5e/python/typeshed/issues/1902 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/7768459e7533d6b361120b1356df16c1b58fd94b4054963b6453f8c154124d5e/python/typeshed/issues/1902 |
| og:image:alt | In the past week alone I've seen several issues where well-meaning contributors wanted to add undocumented attributes to typeshed: #1884 #1885 #1898 #1901 I think we should have a standard policy o... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | gvanrossum |
| hostname | github.com |
| expected-hostname | github.com |
| None | 7d0829bbde9e48b2486cb5dd6d147896eb01d32134627091f818958a935ef3f0 |
| turbo-cache-control | no-preview |
| go-import | github.com/python/typeshed git https://github.com/python/typeshed.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 31696383 |
| octolytics-dimension-repository_nwo | python/typeshed |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 31696383 |
| octolytics-dimension-repository_network_root_nwo | python/typeshed |
| 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 | f3f3a43ca095cdea3abbb394112e971f9fdb94fa |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width