Title: Docstring Conventions · Issue #106 · ODM2/ODM2PythonAPI · GitHub
Open Graph Title: Docstring Conventions · Issue #106 · ODM2/ODM2PythonAPI
X Title: Docstring Conventions · Issue #106 · ODM2/ODM2PythonAPI
Description: This Issue follows up #105 (comment). We need a set of conventions that we should follow when writing docstring within the functions and classes: Follow the google style documentation as discussed in #97. Official example here (and for r...
Open Graph Description: This Issue follows up #105 (comment). We need a set of conventions that we should follow when writing docstring within the functions and classes: Follow the google style documentation as discussed ...
X Description: This Issue follows up #105 (comment). We need a set of conventions that we should follow when writing docstring within the functions and classes: Follow the google style documentation as discussed ...
Opengraph URL: https://github.com/ODM2/ODM2PythonAPI/issues/106
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Docstring Conventions","articleBody":"This Issue follows up https://github.com/ODM2/ODM2PythonAPI/pull/105#discussion_r141936709.\r\n\r\nWe need a set of conventions that we should follow when writing docstring within the functions and classes:\r\n- [X] Follow the google style documentation as discussed in #97. Official example [here](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) (and for reference, [here's a comparison to the numpy style](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/index.html#google-vs-numpy))\r\n- [X] Don't say \"defaults to ____\" unless it needs further explanation. The default value is already available in the method/function definition.\r\n- [X] If function needs to be instantiated, explicitly show in example. See [here for discussion of class vs instance methods.](https://stackoverflow.com/questions/17134653/difference-between-class-and-instance-methods)\r\n- [X] Provide link to Controlled Vocabulary if it needs CV as value.\r\n- [X] **Other code comments besides docstrings** must use `#` rather than triple quotes, because all triple quotes, regardless of where they're found will be interpreted as doctrings by Sphinx.\r\n\r\nCurrently (10/1) one of the best docstrings available as an example is in [ReadODM2.getAffiliations](https://github.com/ODM2/ODM2PythonAPI/blob/master/odm2api/ODM2/services/readService.py#L545)\r\n\r\ncc @emiliom \r\n\r\nPlease add more as necessary.","author":{"url":"https://github.com/lsetiawan","@type":"Person","name":"lsetiawan"},"datePublished":"2017-09-29T19:32:39.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":8},"url":"https://github.com/106/ODM2PythonAPI/issues/106"}
| 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:7ec67f30-60c9-48e7-db23-ec062dce6fd6 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 8C48:388E9D:56BAFE:7CEF8D:6A58B8A3 |
| html-safe-nonce | 6e5fda79560de0808092c9202e52cd2a36e2f07ad8d04e083da63b7d53416079 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4QzQ4OjM4OEU5RDo1NkJBRkU6N0NFRjhEOjZBNThCOEEzIiwidmlzaXRvcl9pZCI6Ijg2MjU0MjQ2NjQ0NjUyOTE0MjgiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 0557b95f5627c3fafbe3090bde7dce9a3a02d80b5b8e542131d3a39099c250d4 |
| hovercard-subject-tag | issue:261746315 |
| 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/106/issue_layout |
| twitter:image | https://opengraph.githubassets.com/d768ad6851f01c7052e584efc24358a134e8cbdd70051985569a81325d8fc384/ODM2/ODM2PythonAPI/issues/106 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/d768ad6851f01c7052e584efc24358a134e8cbdd70051985569a81325d8fc384/ODM2/ODM2PythonAPI/issues/106 |
| og:image:alt | This Issue follows up #105 (comment). We need a set of conventions that we should follow when writing docstring within the functions and classes: Follow the google style documentation as discussed ... |
| 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 | 5f2a0c7865178af3d91dd9f13b0cdfc3c73a2529c873d2780bb4c01271a57ec6 |
| 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 | 8aae7b8d6caacacf5c66eaeb2702d8dc88d85b4a |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width