Title: Append table definition to docstring · Issue #699 · datajoint/datajoint-python · GitHub
Open Graph Title: Append table definition to docstring · Issue #699 · datajoint/datajoint-python
X Title: Append table definition to docstring · Issue #699 · datajoint/datajoint-python
Description: Thinking about improving the documentation of our own database, we thought it would be nice to add the table definition to its docstring. We do this using a decorator on the table definition somewhat like this: def docappend(cls): cls.__...
Open Graph Description: Thinking about improving the documentation of our own database, we thought it would be nice to add the table definition to its docstring. We do this using a decorator on the table definition somewh...
X Description: Thinking about improving the documentation of our own database, we thought it would be nice to add the table definition to its docstring. We do this using a decorator on the table definition somewh...
Opengraph URL: https://github.com/datajoint/datajoint-python/issues/699
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Append table definition to docstring","articleBody":"Thinking about improving the documentation of our own database, we thought it would be nice to add the table definition to its docstring. We do this using a decorator on the table definition somewhat like this:\r\n```python\r\ndef docappend(cls):\r\n cls.__doc__ += cls.definition\r\n return cls\r\n\r\n@docappend\r\n@schema\r\nclass MyTable(dj.Imported):\r\n .....\r\n```\r\nTo us, it seemed like a minor but useful feature to include in a future version of datajoint.","author":{"url":"https://github.com/SimonRenner","@type":"Person","name":"SimonRenner"},"datePublished":"2019-11-12T16:16:34.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/699/datajoint-python/issues/699"}
| 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:ccbd7b4b-a524-fb62-1d56-777c15028e19 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 9D62:331610:14812BE:1C4A076:6A4DEB5A |
| html-safe-nonce | 8994af5e96998ab72125b0d620502bf449552c580d7ec7342c1ed8d75d9e734b |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5RDYyOjMzMTYxMDoxNDgxMkJFOjFDNEEwNzY6NkE0REVCNUEiLCJ2aXNpdG9yX2lkIjoiMTY0MTU4NDY2NDk0OTUwMjM0IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 2bee8b4a22c3aab912ad415f043bd518e8c74795d5191ad56120b3a3d12c75fc |
| hovercard-subject-tag | issue:521650286 |
| 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/datajoint/datajoint-python/699/issue_layout |
| twitter:image | https://opengraph.githubassets.com/08329b775f70f4bb04571fec5837f5e46f8851c5bcdec8ada8fbc8e5ea90b49a/datajoint/datajoint-python/issues/699 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/08329b775f70f4bb04571fec5837f5e46f8851c5bcdec8ada8fbc8e5ea90b49a/datajoint/datajoint-python/issues/699 |
| og:image:alt | Thinking about improving the documentation of our own database, we thought it would be nice to add the table definition to its docstring. We do this using a decorator on the table definition somewh... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | SimonRenner |
| hostname | github.com |
| expected-hostname | github.com |
| None | 06b8a6144231bf3a234f1c2e9993861e07ce98a905912b114aa386c2d7e84b33 |
| turbo-cache-control | no-preview |
| go-import | github.com/datajoint/datajoint-python git https://github.com/datajoint/datajoint-python.git |
| octolytics-dimension-user_id | 2375501 |
| octolytics-dimension-user_login | datajoint |
| octolytics-dimension-repository_id | 5866704 |
| octolytics-dimension-repository_nwo | datajoint/datajoint-python |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 5866704 |
| octolytics-dimension-repository_network_root_nwo | datajoint/datajoint-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 | 1d344bdb7547fe6bca17a59bb2b8aac3dc9532a0 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width