Skip to content

x/net/http2: outdated README #47624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
bradfitz opened this issue Aug 10, 2021 · 3 comments
Closed

x/net/http2: outdated README #47624

bradfitz opened this issue Aug 10, 2021 · 3 comments
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Unreleased

Comments

@bradfitz
Copy link
Contributor

Reading http2 docs at https://pkg.go.dev/golang.org/x/net/http2, the first thing you see is this old text:

This is a work-in-progress HTTP/2 implementation for Go.

It will eventually live in the Go standard library and won't require
any changes to your code to use.  It will just be automatic.

Status:

* The server support is pretty good. A few things are missing
  but are being worked on.
* The client work has just started but shares a lot of code
  is coming along much quicker.

Docs are at https://godoc.org/golang.org/x/net/http2
...

Probably time to update that.
@dmitshur
Copy link
Contributor

CC @neild, @tombergan via owners.

@dmitshur dmitshur added Documentation Issues describing a change to documentation. NeedsFix The path to resolution is known, but the work has not been done. labels Aug 10, 2021
@dmitshur dmitshur added this to the Unreleased milestone Aug 10, 2021
@dmitshur
Copy link
Contributor

The package comment is more up to date and also shows up on pkg.go.dev. Maybe the README should just be deleted from that directory to avoid overlap.

@neild neild self-assigned this Aug 10, 2021
@gopherbot
Copy link
Contributor

Change https://golang.org/cl/341369 mentions this issue: net/http2: delete README

dteh pushed a commit to dteh/fhttp that referenced this issue Jun 22, 2022
@neild
http2: delete README
b3bb1d9 
Out of date, redundant with package doc, just drop it.

Fixes golang/go#47624.

Change-Id: Ic4a686330d69744e57bf01785c53707ba29944b9
Reviewed-on: https://go-review.googlesource.com/c/net/+/341369
Trust: Damien Neil <dneil@google.com>
Reviewed-by: Ian Lance Taylor <iant@golang.org>
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
@rsc rsc unassigned neild Jun 23, 2022
@golang golang locked and limited conversation to collaborators Jun 23, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Unreleased
Development

No branches or pull requests
4 participants
@bradfitz @neild @dmitshur @gopherbot