Skip to content

Commit

Permalink
{tailscale,v2}: capitalize API, tweak package doc
Browse files Browse the repository at this point in the history
Break the package doc up into a second paragraph so the "Docs are
here" part doesn't show up as the synopsis. And fix an old URL
in the v1 docs.

Signed-off-by: Brad Fitzpatrick <[email protected]>
  • Loading branch information
bradfitz committed Nov 22, 2024
1 parent bd4d815 commit c1c7356
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
5 changes: 3 additions & 2 deletions tailscale/client.go
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
// Copyright (c) David Bond, Tailscale Inc, & Contributors
// SPDX-License-Identifier: MIT

// Package tailscale contains a basic implementation of a client for the Tailscale HTTP api. Documentation is here:
// https://github.com/tailscale/tailscale/blob/main/api.md
// Package tailscale contains a basic implementation of a client for the Tailscale HTTP API.
//
// Documentation is at https://tailscale.com/api
package tailscale

import (
Expand Down
5 changes: 3 additions & 2 deletions v2/client.go
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
// Copyright (c) David Bond, Tailscale Inc, & Contributors
// SPDX-License-Identifier: MIT

// Package tsclient contains a basic implementation of a client for the Tailscale HTTP api. Documentation is here:
// https://tailscale.com/api
// Package tsclient contains a basic implementation of a client for the Tailscale HTTP API.
//
// Documentation is at https://tailscale.com/api
package tsclient

import (
Expand Down

0 comments on commit c1c7356

Please sign in to comment.