Title: Ditch sphinx-docstring-typing / use type annotations for `ndb` · Issue #9 · googleapis/python-ndb · GitHub
Open Graph Title: Ditch sphinx-docstring-typing / use type annotations for `ndb` · Issue #9 · googleapis/python-ndb
X Title: Ditch sphinx-docstring-typing / use type annotations for `ndb` · Issue #9 · googleapis/python-ndb
Description: See #6393. The ndb docs were using sphinx-docstring-typing to document things like Optional[bool] and Union[int, bool]. However the extension has a "bug" in that it just blindly replaces members of typing, so that TextProperty gets repla...
Open Graph Description: See #6393. The ndb docs were using sphinx-docstring-typing to document things like Optional[bool] and Union[int, bool]. However the extension has a "bug" in that it just blindly replaces members of...
X Description: See #6393. The ndb docs were using sphinx-docstring-typing to document things like Optional[bool] and Union[int, bool]. However the extension has a "bug" in that it just blindly replaces ...
Opengraph URL: https://github.com/googleapis/python-ndb/issues/9
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Ditch sphinx-docstring-typing / use type annotations for `ndb`","articleBody":"See #6393. The `ndb` docs **were** using [`sphinx-docstring-typing`][1] to document things like `Optional[bool]` and `Union[int, bool]`. However the extension has a \"bug\" in that it just blindly replaces members of `typing`, so that `TextProperty` gets replaced by something along the lines of `\"~typing.Text\"Property`.\r\n\r\nThe nice [`typing`][2] style support can be regained if type annotations are used in cases where relevant.\r\n\r\n[1]: https://github.com/theacodes/sphinx-docstring-typing\r\n[2]: https://docs.python.org/3/library/typing.html","author":{"url":"https://github.com/dhermes","@type":"Person","name":"dhermes"},"datePublished":"2018-11-06T20:54:20Z","url":"https://github.com/googleapis/python-ndb/issues/9"}
| 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:4b4ea803-a8f5-0853-9589-85a1eea4b590 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 9C30:1F7A:1A2C4E2:23FDC98:6B0046D8 |
| html-safe-nonce | 256de4222001bdb0cf844cc5df6b0cdf327b9c3bffbac4cdc0548bef414b924e |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5QzMwOjFGN0E6MUEyQzRFMjoyM0ZEQzk4OjZCMDA0NkQ4IiwidmlzaXRvcl9pZCI6IjYzNDQ3MzQzMzIzNjc2ODUzMzYiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 3884cb55a08ca95b6e1779fc58053e58b86835435c3638379debadf1a115afbb |
| hovercard-subject-tag | issue:413066709 |
| 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/googleapis/python-ndb/9/issue_layout |
| twitter:image | https://opengraph.githubassets.com/d789d76bf9852ea44f3f3d354f368996cba12217b59bcbfbb9eff72a520784a6/googleapis/python-ndb/issues/9 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/d789d76bf9852ea44f3f3d354f368996cba12217b59bcbfbb9eff72a520784a6/googleapis/python-ndb/issues/9 |
| og:image:alt | See #6393. The ndb docs were using sphinx-docstring-typing to document things like Optional[bool] and Union[int, bool]. However the extension has a "bug" in that it just blindly replaces members of... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | dhermes |
| hostname | github.com |
| expected-hostname | github.com |
| None | 7d0829bbde9e48b2486cb5dd6d147896eb01d32134627091f818958a935ef3f0 |
| turbo-cache-control | no-preview |
| go-import | github.com/googleapis/python-ndb git https://github.com/googleapis/python-ndb.git |
| octolytics-dimension-user_id | 16785467 |
| octolytics-dimension-user_login | googleapis |
| octolytics-dimension-repository_id | 171752887 |
| octolytics-dimension-repository_nwo | googleapis/python-ndb |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 171752887 |
| octolytics-dimension-repository_network_root_nwo | googleapis/python-ndb |
| 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