Title: Documentation standard? · Issue #97 · ODM2/ODM2PythonAPI · GitHub
Open Graph Title: Documentation standard? · Issue #97 · ODM2/ODM2PythonAPI
X Title: Documentation standard? · Issue #97 · ODM2/ODM2PythonAPI
Description: I notice that docstrings of functions and classes are a bit confusing. And issue #94 points out that there isn't really a built in documentation for the objects returned by the api calls. After looking at various popular python libraries...
Open Graph Description: I notice that docstrings of functions and classes are a bit confusing. And issue #94 points out that there isn't really a built in documentation for the objects returned by the api calls. After loo...
X Description: I notice that docstrings of functions and classes are a bit confusing. And issue #94 points out that there isn't really a built in documentation for the objects returned by the api calls. After...
Opengraph URL: https://github.com/ODM2/ODM2PythonAPI/issues/97
X: @github
Domain: patch-diff.githubusercontent.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Documentation standard?","articleBody":"I notice that docstrings of functions and classes are a bit confusing. And issue #94 points out that there isn't really a built in documentation for the objects returned by the api calls. \r\n\r\nAfter looking at various popular python libraries out there, it seems like a lot of them follows the Numpy/Scipy docstring [documentation style](https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt#docstring-standard).\r\n\r\n@ocefpaf will set up ODM2PythonAPI documentation to follow a similar approach to [Folium](http://python-visualization.github.io/folium/docs-master/). Looking at the code it seems like this library also follows the numpy/scipy documentation style (@ocefpaf, please correct me if I'm wrong).\r\n\r\nGiven those circumstances, I propose that we use the numpy/scipy standard when documenting the code. What do you all think? @emiliom @ocefpaf @aufdenkampe @horsburgh @sreeder ?","author":{"url":"https://github.com/lsetiawan","@type":"Person","name":"lsetiawan"},"datePublished":"2017-09-27T22:45:18.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":2},"url":"https://github.com/97/ODM2PythonAPI/issues/97"}
| 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:acde4eeb-0afe-0bdd-206f-bede799027d3 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | D578:121D22:28E554C:371D77D:69704C82 |
| html-safe-nonce | 63934b409b2ca5b9d47e2ae31e0a71fa7b212afadbea00afa02ac8bc027ce903 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJENTc4OjEyMUQyMjoyOEU1NTRDOjM3MUQ3N0Q6Njk3MDRDODIiLCJ2aXNpdG9yX2lkIjoiNDQ4ODE0Nzg2MTUyMTg0NTM3OCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 559792727db78d4ec62765ef5a745da73f5ba24c9bf51a218ec13dbf51c29e77 |
| hovercard-subject-tag | issue:261140922 |
| 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/ODM2/ODM2PythonAPI/97/issue_layout |
| twitter:image | https://opengraph.githubassets.com/beb6fa928138d28f2eb605169106462397ee327234e2ba147867f73da51b4670/ODM2/ODM2PythonAPI/issues/97 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/beb6fa928138d28f2eb605169106462397ee327234e2ba147867f73da51b4670/ODM2/ODM2PythonAPI/issues/97 |
| og:image:alt | I notice that docstrings of functions and classes are a bit confusing. And issue #94 points out that there isn't really a built in documentation for the objects returned by the api calls. After loo... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | lsetiawan |
| hostname | github.com |
| expected-hostname | github.com |
| None | 9920a62ba22d06470388e2904804fb7e5ec51c9e35f81784e9191394c74b2bd2 |
| turbo-cache-control | no-preview |
| go-import | github.com/ODM2/ODM2PythonAPI git https://github.com/ODM2/ODM2PythonAPI.git |
| octolytics-dimension-user_id | 12091612 |
| octolytics-dimension-user_login | ODM2 |
| octolytics-dimension-repository_id | 34542098 |
| octolytics-dimension-repository_nwo | ODM2/ODM2PythonAPI |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 34542098 |
| octolytics-dimension-repository_network_root_nwo | ODM2/ODM2PythonAPI |
| 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 | f643964067a552f02067066d6a910b2f90a5721f |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width