René's URL Explorer Experiment


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

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@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-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:7ec67f30-60c9-48e7-db23-ec062dce6fd6
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-id8C48:388E9D:56BAFE:7CEF8D:6A58B8A3
html-safe-nonce6e5fda79560de0808092c9202e52cd2a36e2f07ad8d04e083da63b7d53416079
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4QzQ4OjM4OEU5RDo1NkJBRkU6N0NFRjhEOjZBNThCOEEzIiwidmlzaXRvcl9pZCI6Ijg2MjU0MjQ2NjQ0NjUyOTE0MjgiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac0557b95f5627c3fafbe3090bde7dce9a3a02d80b5b8e542131d3a39099c250d4
hovercard-subject-tagissue:261746315
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/ODM2/ODM2PythonAPI/106/issue_layout
twitter:imagehttps://opengraph.githubassets.com/d768ad6851f01c7052e584efc24358a134e8cbdd70051985569a81325d8fc384/ODM2/ODM2PythonAPI/issues/106
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/d768ad6851f01c7052e584efc24358a134e8cbdd70051985569a81325d8fc384/ODM2/ODM2PythonAPI/issues/106
og:image:altThis 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:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamelsetiawan
hostnamegithub.com
expected-hostnamegithub.com
None5f2a0c7865178af3d91dd9f13b0cdfc3c73a2529c873d2780bb4c01271a57ec6
turbo-cache-controlno-preview
go-importgithub.com/ODM2/ODM2PythonAPI git https://github.com/ODM2/ODM2PythonAPI.git
octolytics-dimension-user_id12091612
octolytics-dimension-user_loginODM2
octolytics-dimension-repository_id34542098
octolytics-dimension-repository_nwoODM2/ODM2PythonAPI
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id34542098
octolytics-dimension-repository_network_root_nwoODM2/ODM2PythonAPI
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release8aae7b8d6caacacf5c66eaeb2702d8dc88d85b4a
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/ODM2/ODM2PythonAPI/issues/106#start-of-content
https://github.com/
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2FODM2%2FODM2PythonAPI%2Fissues%2F106
GitHub CopilotWrite better code with AIhttps://github.com/features/copilot
GitHub Copilot appDirect agents from issue to mergehttps://github.com/features/ai/github-app
MCP RegistryNewIntegrate external toolshttps://github.com/mcp
ActionsAutomate any workflowhttps://github.com/features/actions
CodespacesInstant dev environmentshttps://github.com/features/codespaces
IssuesPlan and track workhttps://github.com/features/issues
Code ReviewManage code changeshttps://github.com/features/code-review
GitHub Advanced SecurityFind and fix vulnerabilitieshttps://github.com/security/advanced-security
Code securitySecure your code as you buildhttps://github.com/security/advanced-security/code-security
Secret protectionStop leaks before they starthttps://github.com/security/advanced-security/secret-protection
Why GitHubhttps://github.com/why-github
Documentationhttps://docs.github.com
Bloghttps://github.blog
Changeloghttps://github.blog/changelog
Marketplacehttps://github.com/marketplace
View all featureshttps://github.com/features
Enterpriseshttps://github.com/enterprise
Small and medium teamshttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
App Modernizationhttps://github.com/solutions/use-case/app-modernization
DevSecOpshttps://github.com/solutions/use-case/devsecops
DevOpshttps://github.com/solutions/use-case/devops
CI/CDhttps://github.com/solutions/use-case/ci-cd
View all use caseshttps://github.com/solutions/use-case
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
View all industrieshttps://github.com/solutions/industry
View all solutionshttps://github.com/solutions
AIhttps://github.com/resources/articles?topic=ai
Software Developmenthttps://github.com/resources/articles?topic=software-development
DevOpshttps://github.com/resources/articles?topic=devops
Securityhttps://github.com/resources/articles?topic=security
View all topicshttps://github.com/resources/articles
Customer storieshttps://github.com/customer-stories
Events & webinarshttps://github.com/resources/events
Ebooks & reportshttps://github.com/resources/whitepapers
Business insightshttps://github.com/solutions/executive-insights
GitHub Skillshttps://skills.github.com
Documentationhttps://docs.github.com
Customer supporthttps://support.github.com
Community forumhttps://github.com/orgs/community/discussions
Trust centerhttps://github.com/trust-center
Partnershttps://github.com/partners
View all resourceshttps://github.com/resources
GitHub SponsorsFund open source developershttps://github.com/open-source/sponsors
Security Labhttps://securitylab.github.com
Maintainer Communityhttps://maintainers.github.com
Acceleratorhttps://github.com/open-source/accelerator
GitHub Starshttps://stars.github.com
Archive Programhttps://archiveprogram.github.com
Topicshttps://github.com/topics
Trendinghttps://github.com/trending
Collectionshttps://github.com/collections
Enterprise platformAI-powered developer platformhttps://github.com/enterprise
GitHub Advanced SecurityEnterprise-grade security featureshttps://github.com/security/advanced-security
Copilot for BusinessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Pricinghttps://github.com/pricing
Search syntax tipshttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
documentationhttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2FODM2%2FODM2PythonAPI%2Fissues%2F106
Sign up https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=ODM2%2FODM2PythonAPI
Reloadhttps://github.com/ODM2/ODM2PythonAPI/issues/106
Reloadhttps://github.com/ODM2/ODM2PythonAPI/issues/106
Reloadhttps://github.com/ODM2/ODM2PythonAPI/issues/106
Please reload this pagehttps://github.com/ODM2/ODM2PythonAPI/issues/106
ODM2 https://github.com/ODM2
ODM2PythonAPIhttps://github.com/ODM2/ODM2PythonAPI
Notifications https://github.com/login?return_to=%2FODM2%2FODM2PythonAPI
Fork 13 https://github.com/login?return_to=%2FODM2%2FODM2PythonAPI
Star 5 https://github.com/login?return_to=%2FODM2%2FODM2PythonAPI
Code https://github.com/ODM2/ODM2PythonAPI
Issues 29 https://github.com/ODM2/ODM2PythonAPI/issues
Pull requests 1 https://github.com/ODM2/ODM2PythonAPI/pulls
Actions https://github.com/ODM2/ODM2PythonAPI/actions
Projects https://github.com/ODM2/ODM2PythonAPI/projects
Wiki https://github.com/ODM2/ODM2PythonAPI/wiki
Security and quality 0 https://github.com/ODM2/ODM2PythonAPI/security
Insights https://github.com/ODM2/ODM2PythonAPI/pulse
Code https://github.com/ODM2/ODM2PythonAPI
Issues https://github.com/ODM2/ODM2PythonAPI/issues
Pull requests https://github.com/ODM2/ODM2PythonAPI/pulls
Actions https://github.com/ODM2/ODM2PythonAPI/actions
Projects https://github.com/ODM2/ODM2PythonAPI/projects
Wiki https://github.com/ODM2/ODM2PythonAPI/wiki
Security and quality https://github.com/ODM2/ODM2PythonAPI/security
Insights https://github.com/ODM2/ODM2PythonAPI/pulse
Docstring Conventionshttps://github.com/ODM2/ODM2PythonAPI/issues/106#top
https://github.com/lsetiawan
lsetiawanhttps://github.com/lsetiawan
on Sep 29, 2017https://github.com/ODM2/ODM2PythonAPI/issues/106#issue-261746315
#105 (comment)https://github.com/ODM2/ODM2PythonAPI/pull/105#discussion_r141936709
Documentation standard? #97https://github.com/ODM2/ODM2PythonAPI/issues/97
herehttp://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
here's a comparison to the numpy stylehttp://sphinxcontrib-napoleon.readthedocs.io/en/latest/index.html#google-vs-numpy
here for discussion of class vs instance methods.https://stackoverflow.com/questions/17134653/difference-between-class-and-instance-methods
ReadODM2.getAffiliationshttps://github.com/ODM2/ODM2PythonAPI/blob/master/odm2api/ODM2/services/readService.py#L545
@emiliomhttps://github.com/emiliom
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.