Title: Built-in methods/classes/functions lack documentation. · Issue #2680 · RustPython/RustPython · GitHub
Open Graph Title: Built-in methods/classes/functions lack documentation. · Issue #2680 · RustPython/RustPython
X Title: Built-in methods/classes/functions lack documentation. · Issue #2680 · RustPython/RustPython
Description: Most (?) of the built in functionality currently lacks corresponding documentation. The functionality to grab and attach the docs is there, the docs just haven't been added. This, I believe, could make a good first issue for many people,...
Open Graph Description: Most (?) of the built in functionality currently lacks corresponding documentation. The functionality to grab and attach the docs is there, the docs just haven't been added. This, I believe, could ...
X Description: Most (?) of the built in functionality currently lacks corresponding documentation. The functionality to grab and attach the docs is there, the docs just haven't been added. This, I believe, co...
Opengraph URL: https://github.com/RustPython/RustPython/issues/2680
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Built-in methods/classes/functions lack documentation.","articleBody":"Most (?) of the built in functionality currently lacks corresponding documentation. The functionality to grab and attach the docs is there, the docs just haven't been added. \r\n\r\nThis, I believe, could make a good first issue for many people, it just involves taking the documentation and adding it before (after works too but most current examples add it before) the `#[py(function/method/class)]` attribute. As an example, for `list.append` one could just add:\r\n\r\n```rust\r\n/// Append object to the end of the list.\r\n#[pymethod]\r\npub(crate) fn append(&self, x: PyObjectRef) { ... }\r\n```\r\n\r\nThe main built-in classes seem to have documentation for the classes but not for the methods. Builtin modules, I'd assume, probably also have many more cases.","author":{"url":"https://github.com/DimitrisJim","@type":"Person","name":"DimitrisJim"},"datePublished":"2021-05-30T14:14:19Z","url":"https://github.com/RustPython/RustPython/issues/2680"}
| 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:4781bcf3-2e9e-edfb-5d4c-2ccc8585fc30 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | C010:2F543F:19B1695:21F3B45:6B021519 |
| html-safe-nonce | 42a8cc762a4ee54852b4b55b011ce53108cfb0af3cee0863626235f7a6875aac |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDMDEwOjJGNTQzRjoxOUIxNjk1OjIxRjNCNDU6NkIwMjE1MTkiLCJ2aXNpdG9yX2lkIjoiMTI3OTMzMDI0NTEyMzY0MjY1MCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | bd8882ebdf3e84b4d616d04ad77aceb4952df9da7456ab03b7c0e8c439ada3af |
| hovercard-subject-tag | issue:906769876 |
| 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/RustPython/RustPython/2680/issue_layout |
| twitter:image | https://opengraph.githubassets.com/ae5a00629c9b589aa78273293068100bcf7960a2aee88c25a938fa493d39a40b/RustPython/RustPython/issues/2680 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/ae5a00629c9b589aa78273293068100bcf7960a2aee88c25a938fa493d39a40b/RustPython/RustPython/issues/2680 |
| og:image:alt | Most (?) of the built in functionality currently lacks corresponding documentation. The functionality to grab and attach the docs is there, the docs just haven't been added. This, I believe, could ... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | DimitrisJim |
| hostname | github.com |
| expected-hostname | github.com |
| None | 87e774ee7c6b3bee0490394e4d3e57ec9dbc956f74b87ea685dc8996c1676456 |
| turbo-cache-control | no-preview |
| go-import | github.com/RustPython/RustPython git https://github.com/RustPython/RustPython.git |
| octolytics-dimension-user_id | 39710557 |
| octolytics-dimension-user_login | RustPython |
| octolytics-dimension-repository_id | 135201145 |
| octolytics-dimension-repository_nwo | RustPython/RustPython |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 135201145 |
| octolytics-dimension-repository_network_root_nwo | RustPython/RustPython |
| 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 | 423dbb54c5e7bfecc838eb387c1435eb3d0e760d |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width