Feature #18672

[go sdk] describe + implement desired Go SDK

Added by Ward Vandewege 4 months ago. Updated 4 months ago.

Status:
New
Priority:
Normal
Assigned To:
-
Category:
-
Target version:
-
Start date:
Due date:
% Done:

0%

Estimated time:
Story points:
-

Description

Something like

 import (
   "git.arvados.org/arvados.git/lib/arvados" 
 )
  // Get an Arvados API object (cf. https://pkg.go.dev/git.arvados.org/arvados.git@v0.0.0-20220124190027-e372194dc9b4/sdk/go/arvados#API)
  arv := arvados.NewClient()

We can then add examples for all the functions available on the API object.

We can rename all the other types in the arvados module? Or move them elsewhere? Or at least make the godoc index more indented/easier to read?


Related issues

Blocks Arvados - Bug #18671: [go sdk] update documentationNew

History

#1 Updated by Ward Vandewege 4 months ago

  • Description updated (diff)

#2 Updated by Ward Vandewege 4 months ago

  • Description updated (diff)

#3 Updated by Ward Vandewege 4 months ago

  • Blocks Bug #18671: [go sdk] update documentation added

#4 Updated by Ward Vandewege 4 months ago

  • Description updated (diff)

Also available in: Atom PDF