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.

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

x/xerrors: clarify documentation around stack frames #34349

Open
samcgardner opened this issue Sep 17, 2019 · 3 comments
Open

x/xerrors: clarify documentation around stack frames #34349

samcgardner opened this issue Sep 17, 2019 · 3 comments

Comments

@samcgardner
Copy link

@samcgardner samcgardner commented Sep 17, 2019

The docs for the x/xerrors package currently state

Most of the functions and types in this package will be incorporated into the standard library's errors package in Go 1.13; the behavior of this package's Errorf function will be incorporated into the standard library's fmt.Errorf. 

This is not accurate. fmt.Errorf does not provide the stack-trace functionality of xerrors.Errorf. Accordingly, I would suggest changing this docstring to

Most of the functions and types in this package have been incorporated into the standard library's errors package in Go 1.13. However, if you wish to retain the stack trace functionality of `xerrors.Errorf`, you will need to keep using this package.
@gopherbot gopherbot added this to the Unreleased milestone Sep 17, 2019
@toothrot toothrot changed the title x/xerrors Misleading Docstring x/xerrors: clarify documentation around stack frames Sep 17, 2019
@toothrot

This comment has been minimized.

Copy link
Contributor

@toothrot toothrot commented Sep 17, 2019

/cc @jba @neild @mpvl who may be able to help improve the phrasing.

@flibustenet

This comment has been minimized.

Copy link

@flibustenet flibustenet commented Oct 4, 2019

Is there an issue to follow if stack trace will be part of go1.14 ?

@jba

This comment has been minimized.

Copy link
Contributor

@jba jba commented Oct 5, 2019

I wrote https://go-review.googlesource.com/c/xerrors/+/199317 to update the doc.

We have no work on errors planned for 1.14. We're going to wait a cycle.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
5 participants
You can’t perform that action at this time.