Title: `import_od` and `export_od` are undocumented · Issue #472 · canopen-python/canopen · GitHub
Open Graph Title: `import_od` and `export_od` are undocumented · Issue #472 · canopen-python/canopen
X Title: `import_od` and `export_od` are undocumented · Issue #472 · canopen-python/canopen
Description: Disclaimer: apologies in advance if these are intentionally excluded from the docs. It seems to me, judging from their docstrings, that import_od and export_od have been unintentionally excluded from the docs. Adding them is trivial: dif...
Open Graph Description: Disclaimer: apologies in advance if these are intentionally excluded from the docs. It seems to me, judging from their docstrings, that import_od and export_od have been unintentionally excluded fr...
X Description: Disclaimer: apologies in advance if these are intentionally excluded from the docs. It seems to me, judging from their docstrings, that import_od and export_od have been unintentionally excluded fr...
Opengraph URL: https://github.com/canopen-python/canopen/issues/472
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"`import_od` and `export_od` are undocumented","articleBody":"_Disclaimer: apologies in advance if these are intentionally excluded from the docs._\r\n\r\nIt seems to me, judging from their docstrings, that `import_od` and `export_od` have been unintentionally excluded from the docs. Adding them is trivial:\r\n\r\n```diff\r\ndiff --git a/doc/od.rst b/doc/od.rst\r\nindex 6040bb5..4b88e5f 100644\r\n--- a/doc/od.rst\r\n+++ b/doc/od.rst\r\n@@ -54,6 +54,10 @@ You can access the objects using either index/subindex or names::\r\n API\r\n ---\r\n \r\n+.. autofunction:: canopen.export_od\r\n+\r\n+.. autofunction:: canopen.import_od\r\n+\r\n .. autoclass:: canopen.ObjectDictionary\r\n :members:\r\n```\r\n\r\nHowever, I think this simple patch should be coupled with some minor improvements of the docstrings in question. I can open a PR, unless you prefer these APIs should remain undocumented.","author":{"url":"https://github.com/erlend-aasland","@type":"Person","name":"erlend-aasland"},"datePublished":"2024-06-29T20:55:46.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/472/canopen/issues/472"}
| 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:d19f041f-2ed3-c917-cb20-fd75339bef68 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 8506:2781A3:23E5ACE:3222489:6A5F53E2 |
| html-safe-nonce | b6e8413606a6eb16ecf22d20f7fe51ebeab42f4213aadf456e7c20c64e651904 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4NTA2OjI3ODFBMzoyM0U1QUNFOjMyMjI0ODk6NkE1RjUzRTIiLCJ2aXNpdG9yX2lkIjoiMjU3MzkxMjQyNDExNTU1NzM0NiIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 6cbb3ac2ff6727d3584d3ef5171befbb262698c233e4f83e7fea80c5e610a479 |
| hovercard-subject-tag | issue:2381955859 |
| 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/canopen-python/canopen/472/issue_layout |
| twitter:image | https://opengraph.githubassets.com/5ec660e7ac2bd1d97911ff32ded526d5f7daf5d1352859b14509ff49f84ab052/canopen-python/canopen/issues/472 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/5ec660e7ac2bd1d97911ff32ded526d5f7daf5d1352859b14509ff49f84ab052/canopen-python/canopen/issues/472 |
| og:image:alt | Disclaimer: apologies in advance if these are intentionally excluded from the docs. It seems to me, judging from their docstrings, that import_od and export_od have been unintentionally excluded fr... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | erlend-aasland |
| hostname | github.com |
| expected-hostname | github.com |
| None | 9a0797c11799dbfd7df57fa3de31c7ea3a4c4bd055eb1a0427a5cde1d4d7ba3f |
| turbo-cache-control | no-preview |
| go-import | github.com/canopen-python/canopen git https://github.com/canopen-python/canopen.git |
| octolytics-dimension-user_id | 200581454 |
| octolytics-dimension-user_login | canopen-python |
| octolytics-dimension-repository_id | 68737600 |
| octolytics-dimension-repository_nwo | canopen-python/canopen |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 68737600 |
| octolytics-dimension-repository_network_root_nwo | canopen-python/canopen |
| 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 | b099d96da147aea31036cd16b2fba0083a6defe4 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width