Skip to content
This repository has been archived by the owner on Feb 16, 2023. It is now read-only.

Add examples to godoc #164

Merged
merged 9 commits into from
Dec 23, 2019
Merged

Add examples to godoc #164

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a5b196c
Add examples for Client and Rand
Marton6 Dec 19, 2019
7111a75
Add client creation example
Marton6 Dec 19, 2019
cde53f4
Add example for directory creation
Marton6 Dec 19, 2019
dddb8d4
Merge branch 'develop' into feature/godoc-examples
Marton6 Dec 21, 2019
88f2caf
Update randchar examples
Marton6 Dec 21, 2019
06af90d
Update comment
Marton6 Dec 21, 2019
793bf27
Update randchar examples move to randchar test
Marton6 Dec 21, 2019
27ebcca
Update client examples
Marton6 Dec 21, 2019
98c8239
Update client creation examples
Marton6 Dec 23, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions pkg/secrethub/example_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,26 @@ import (

var client ClientInterface

// Create a new Client.
func ExampleNewClient() {
client, err := NewClient()
if err != nil {
log.Fatal(err)
}

fmt.Printf("Client with ID: %s", client.account.AccountID.String())
}

// Create a new aws Client.
Marton6 marked this conversation as resolved.
Show resolved Hide resolved
func ExampleNewClient_aws() {
client, err := NewClient(WithCredentials(credentials.UseAWS()))
if err != nil {
log.Fatal(err)
}

fmt.Printf("Client with ID: %s", client.account.AccountID.String())
}

// Create a new repository.
func ExampleClient_Repos_create() {
_, err := client.Repos().Create("workspace/repo")
Expand Down