Skip to content

[v2] docs: Remove outdated godoc#3219

Merged
EmilienM merged 1 commit intov2from
bp-v2-3966ef3
Oct 17, 2024
Merged

[v2] docs: Remove outdated godoc#3219
EmilienM merged 1 commit intov2from
bp-v2-3966ef3

Conversation

@gophercloud-backport-bot
Copy link
Copy Markdown

Backport: #3217

The doc.go file, and go.dev as a consequence, was still recommending to use utils for authentication.

Since the automatically-generated documentation on the Go website already includes the README, we can delete doc.go and keep README.md as the canonical introduction to the module.

Fixes #3216

The `doc.go` file, and
[go.dev](https://pkg.go.dev/github.com/gophercloud/gophercloud/v2) as a
consequence, was still recommending to use utils for authentication.

Since the automatically-generated documentation on the Go website
already includes the README, we can delete doc.go and keep README.md as
the canonical introduction to the module.
@github-actions github-actions bot added v2 This PR targets v2 edit:gophercloud This PR updates common Gophercloud code semver:patch No API change labels Oct 17, 2024
@coveralls
Copy link
Copy Markdown

Coverage Status

coverage: 78.717%. remained the same
when pulling 0d1c2a0 on bp-v2-3966ef3
into 1c4dd03 on v2.

@EmilienM EmilienM merged commit 33138c0 into v2 Oct 17, 2024
@EmilienM EmilienM deleted the bp-v2-3966ef3 branch October 17, 2024 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

edit:gophercloud This PR updates common Gophercloud code semver:patch No API change v2 This PR targets v2

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants