Fix(go): Document public interfaces of the core

IBM / go-sdk-core

The go-sdk-core repository contains core functionality required by Go code generated by the IBM OpenAPI SDK Generator.

Apache License 2.0

30 stars 24 forks source link

Fix(go): Document public interfaces of the core #40

Closed mgrattray closed 4 years ago

mgrattray commented 4 years ago

Fixes: arf/planning-sdk-squad#1135

Reference for changes: https://blog.golang.org/godoc-documenting-go-code

Explanation: The go core was mostly already well-documented. However, I found it diverges it a bit from what is standard within Go. Although not explicitly stated it seems Go leans towards subject-verb sentences where the subject is the interface being commented.

Changes:

Change comments to be subject-verb sentences
Change some of the languages to mirror comments in other cores.

padamstx commented 4 years ago

@mgrattray it looks like you might have used the "commit suggested change" button for a bunch of my review comments, but that has left things in a weird state. Please pull your feature branch down to your local environment and update the comments as needed to fix this.

mgrattray commented 4 years ago

@mgrattray it looks like you might have used the "commit suggested change" button for a bunch of my review comments, but that has left things in a weird state. Please pull your feature branch down to your local environment and update the comments as needed to fix this. 👍 Ok

ibm-devx-automation commented 4 years ago

:tada: This PR is included in version 2.0.1 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket: