Skip to content

net/http: ambiguous sentence in docs for Response.ParseForm #16609

Closed
@earthboundkid

Description

@earthboundkid

Please answer these questions before submitting your issue. Thanks!

1 What version of Go are you using (go version)?

go1.6.2

2 What operating system and processor architecture are you using (go env)?

GOARCH="amd64"
GOBIN=""
GOEXE=""
GOHOSTARCH="amd64"
GOHOSTOS="darwin"
GOOS="darwin"
GOPATH="/Users/cjohnson/Documents/Code/Golang"
GORACE=""
GOROOT="/usr/local/Cellar/go/1.6.2/libexec"
GOTOOLDIR="/usr/local/Cellar/go/1.6.2/libexec/pkg/tool/darwin_amd64"
GO15VENDOREXPERIMENT="1"
CC="clang"
GOGCCFLAGS="-fPIC -m64 -pthread -fno-caret-diagnostics -Qunused-arguments -fmessage-length=0 -fno-common"
CXX="clang++"
CGO_ENABLED="1"

3 What did you do?

$ go doc http.ParseForm
func (r *Request) ParseForm() error
    ParseForm parses the raw query from the URL and updates r.Form.

    For POST or PUT requests, it also parses the request body as a form and put
    the results into both r.PostForm and r.Form. POST and PUT body parameters
    take precedence over URL query string values in r.Form.

    If the request Body's size has not already been limited by MaxBytesReader,
    the size is capped at 10MB.

    ParseMultipartForm calls ParseForm automatically. It is idempotent.

4 What did you expect to see?

Grammatically unambiguous documentation.

5 What did you see instead?

In "It is idempotent," "it" ambiguously refers to ParseForm or ParseMultipartForm or both.

I think it should be ParseForm, but I'm not sure. Maybe both?

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationIssues describing a change to documentation.FrozenDueToAgeNeedsFixThe path to resolution is known, but the work has not been done.

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions