Skip to content
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

errors: examples need improvement #31716

Open
FiloSottile opened this issue Apr 27, 2019 · 4 comments
Open

errors: examples need improvement #31716

FiloSottile opened this issue Apr 27, 2019 · 4 comments
Labels
Documentation Issues describing a change to documentation. NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Backlog

Comments

@FiloSottile
Copy link
Contributor

There is a total of 4 examples in the package. Two are for New, one doesn't use the package at all, and one incorrectly uses As by dropping the error on the floor if it's not a os.PathError.

	_, err := os.Open("non-existing")
	if err != nil {
		var pathError *os.PathError
		if errors.As(err, &pathError) {
			fmt.Println("Failed at path:", pathError.Path)
		}
	}
@FiloSottile FiloSottile added the NeedsFix The path to resolution is known, but the work has not been done. label Apr 27, 2019
@FiloSottile FiloSottile added this to the Go1.13 milestone Apr 27, 2019
@ALTree ALTree added the Documentation Issues describing a change to documentation. label Apr 27, 2019
@corona10
Copy link
Contributor

@FiloSottile Can I take a look at this issue?

@gopherbot
Copy link
Contributor

Change https://golang.org/cl/175257 mentions this issue: errors: Add errors.Is examples

@gopherbot
Copy link
Contributor

Change https://golang.org/cl/179737 mentions this issue: errors: fix package example

gopherbot pushed a commit that referenced this issue Jun 3, 2019
@adg
errors: fix package example
5e2af2b 
The example in example_test.go requires that the whole file be
displayed; the addition of ExampleAs meant that only the body of the
package example function was shown, rather than the surrounding context.

This change moves ExampleAs to the file wrap_test.go file, restoring the
package example to its former glory.

Update #31716

Change-Id: Id0ea77bc06023b239a63c1d6a7c8b3c1dae91ce9
Reviewed-on: https://go-review.googlesource.com/c/go/+/179737
Reviewed-by: Marcel van Lohuizen <mpvl@golang.org>
Reviewed-by: Jean de Klerk <deklerk@google.com>
Run-TryBot: Benny Siegert <bsiegert@gmail.com>
TryBot-Result: Gobot Gobot <gobot@golang.org>
@andybons andybons modified the milestones: Go1.13, Go1.14 Jul 8, 2019
@cespare cespare mentioned this issue Jul 30, 2019
Closed
@rsc rsc modified the milestones: Go1.14, Backlog Oct 9, 2019
@katiehockman katiehockman mentioned this issue Apr 10, 2020
Closed
@gopherbot
Copy link
Contributor

Change https://golang.org/cl/228038 mentions this issue: errors: add example for Is

gopherbot pushed a commit that referenced this issue Apr 13, 2020
@jba
errors: add example for Is
7b5303d 
Add ExampleIs to illustrate how errors.Is works.

Updates #31716.
Updates #38369.

Change-Id: I1b9a6667614635aa3a5ed8b2c108d8eb6f35748b
Reviewed-on: https://go-review.googlesource.com/c/go/+/228038
Reviewed-by: Damien Neil <dneil@google.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Issues describing a change to documentation. NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Backlog
Development

No branches or pull requests
6 participants
@rsc @andybons @FiloSottile @ALTree @corona10 @gopherbot