This repository has been archived by the owner on Dec 1, 2021. It is now read-only.
Make example interfaces unnamed #55
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To avoid bike shedding over the name, and make it clear that these interface defintions are _not_ provided by this package.
|
/cc @kr |
|
I am happy to see this change. I've found this technique of showing notional interfaces that are not actually defined by the name to be confusing. Clients of the library can't actually refer to that name, nor even find it in the source code apart from in a comment. Better is to omit the name as you've done here. |
| @@ -59,7 +59,7 @@ | |||
| // New, Errorf, Wrap, and Wrapf record a stack trace at the point they are | |||
| // invoked. This information can be retrieved with the following interface. | |||
| // | |||
| // type StackTrace interface { | |||
| // interface { | |||
There was a problem hiding this comment.
What about the example cast that mentions the StackTrace type a few lines down? Should that change as well?
There was a problem hiding this comment.
Well, that does make things complicated.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To avoid bike shedding over the name, and make it clear that these
interface defintions are not provided by this package.