Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Functions, Types and Methods are undocumented #4

Closed
stevvooe opened this issue Dec 1, 2014 · 1 comment · Fixed by #16
Closed

Functions, Types and Methods are undocumented #4

stevvooe opened this issue Dec 1, 2014 · 1 comment · Fixed by #16

Comments

@stevvooe
Copy link

stevvooe commented Dec 1, 2014

All the objects in the SDK packages are completely undocumented, making it hard to understand how to use the API. This is most obvious when reading the godoc for the package.
@ahmetb ahmetb self-assigned this Jan 26, 2015
@ahmetb ahmetb mentioned this issue Jan 27, 2015
Merged
ahmetb added a commit to ahmetb/azure-sdk-for-go that referenced this issue Jan 27, 2015
@ahmetb
Added godoc for exported blob client methods and types
f10145e 
Rearranged several methods like DeleteBlobIfExists.
Closes Azure#4.

Signed-off-by: Ahmet Alp Balkan <[email protected]>
@stevvooe
Copy link
Author

@ahmetalpbalkan Thanks! This is much better!

As an aside, we use golint during our build to check exported documentation for each PR. Its obnoxious, at first, but ensures that everything gets some docs.

AutorestCI added a commit that referenced this issue Mar 15, 2018
@AutorestCI
Generated from 06794ac5285e95cc2999834eb565b766760be495
4f4a63c 
Merge pull request #4 from TimeSeriesInsights/add-spec-RefDataSet-NewProp

Added dataStringComparisonBehavior parameter to reference data put/update spec
AutorestCI added a commit that referenced this issue Mar 19, 2018
@AutorestCI
Generated from 06794ac5285e95cc2999834eb565b766760be495
d090ae4 
Merge pull request #4 from TimeSeriesInsights/add-spec-RefDataSet-NewProp

Added dataStringComparisonBehavior parameter to reference data put/update spec
AutorestCI added a commit that referenced this issue Apr 20, 2018
@AutorestCI
Generated from 8e3c1b45d0234eeebeab1d7ebdcc2a30ce1d7179
7eeb74b 
A few improvements and fixes (#4)

* A few improvements and fixes

* Fix the description for build arguments

* Remove error schema

* use 2017-10-01 tag

* Add default response back
AutorestCI added a commit that referenced this issue Apr 24, 2018
@AutorestCI
[AutoPR containerregistry/resource-manager] Azure Container Registry …
a1f4080 
…Auto Build Feature Swagger and examples (#1662)

* Generated from 8e3c1b45d0234eeebeab1d7ebdcc2a30ce1d7179

A few improvements and fixes (#4)

* A few improvements and fixes

* Fix the description for build arguments

* Remove error schema

* use 2017-10-01 tag

* Add default response back

* Generated from 5fa239f0f0abdd6dbba20252958288384b5fe797

Fix Error status, fix version (#5)

* Remove error schema

* Add default response back

* Fix abandoned as system error

* Fix Error status

* Use preview tag

* Fix tag

* Remove error response schema as they are not used

* Generated from 074adc160df8cd2dbe1c3295c478f7092ba09207

Fix CI (#7)

* Add python sdk version

* Add preview to namespace

* Remove an example

* Generated from 5e072f9f70cfd1ff9a8eb343e4d3d42e7c338a8a

Fix examples (#8)
richardpark-msft pushed a commit to richardpark-msft/azure-sdk-for-go that referenced this issue Aug 5, 2021
@devigned
Merge pull request Azure#4 from devigned/feature/topics
9c93d75 
Add management features for topics and subscriptions
@ItalyPaleAle ItalyPaleAle mentioned this issue Jul 11, 2022
Closed
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Added godoc for exported blob client methods and types ahmetb/azure-sdk-for-go
2 participants
@stevvooe @ahmetb