c/ooni-probe-cli
Watch
1
0
Fork
You've already forked ooni-probe-cli
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

doc: cleanup and improve for recently moved pkgs (#354)

Browse source 
* chore(atomicx): review docs and add usage example

* chore(fsx): improve docs, return value, add examples

* fix(kvstore): correct typo and add example

* fix(multierror): add basic example

* doc: revamp ooapi documentation
This commit is contained in:
Simone Basso 2021-06-04 11:39:00 +02:00 • committed by GitHub
commit acd4ffff35
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 172 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

7
internal/ooapi/doc.go
View file

@ -15,9 +15,6 @@
// perform the login. If an API uses caching, we will
// automatically use the cache.
//
// See the example describing auto-login for more information
// on how to use auto-login.
//
// Design
//
// Most of the code in this package is auto-generated from the
@ -46,11 +43,11 @@
//
// Architecture
//
// The ./apimodel package contains the definition of request
// The ./apimodel sub-package contains the definition of request
// and response messages. We rely on tagging to specify how
// we should encode and decode messages.
//
// The ./internal/generator contains code to generate most
// The ./internal/generator sub-package contains code to generate most
// code in this package. In particular, the spec.go file is
// the specification of the APIs.
package ooapi