all: add godoc link everywhere possible. #1112
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
zero code changes, only godoc update
ccoVeille
changed the title
mvdan
approved these changes
Jan 2, 2025
| @@ -457,7 +457,7 @@ func stdinFile(r io.Reader) (*os.File, error) { | |||
| // Note that providing a non-nil standard input other than [os.File] will require | |||
| // an [os.Pipe] and spawning a goroutine to copy into it, | |||
| // as an [os.File] is the only way to share a reader with subprocesses. | |||
| // See [os/exec.Cmd.Stdin]. | |||
| // See os/[exec.Cmd.Stdin]. | |||
There was a problem hiding this comment.
I'm undoing this change as it seems unnecessary and makes the linking less consistent.
| @@ -947,7 +947,7 @@ func (r *Runner) readLine(ctx context.Context, raw bool) ([]byte, error) { | |||
| // [cancelreader.NewReader] may fail under some circumstances, such as r.stdin being | |||
| // a regular file on Linux, in which case epoll returns an "operation not permitted" error | |||
| // given that regular files can always be read immediately. Polling them makes no sense. | |||
| // As such, if cancelreader fails, fall back to no cancellation, meaning this is best-effort. | |||
| // As such, if [cancelreader] fails, fall back to no cancellation, meaning this is best-effort. | |||
There was a problem hiding this comment.
this code is gone from master now; removing this change.
| @@ -209,7 +210,7 @@ func LookPath(env expand.Environ, file string) (string, error) { | |||
| return LookPathDir(env.Get("PWD").String(), env, file) | |||
| } | |||
|
|
|||
| // LookPathDir is similar to [os/exec.LookPath], with the difference that it uses the | |||
| // LookPathDir is similar to os/[exec.LookPath], with the difference that it uses the | |||
| @@ -54,7 +54,7 @@ func TestRunnerTerminalStdIO(t *testing.T) { | |||
|
|
|||
| r, _ := interp.New(interp.StdIO(secondaryReader, secondary, secondary)) | |||
| go func() { | |||
| // To mimic os/exec.Cmd.Start, use a goroutine. | |||
| // To mimic os/[exec.Cmd.Start], use a goroutine. | |||
There was a problem hiding this comment.
tweaking to quote the entire qualified name, like the others.
| @@ -279,7 +279,7 @@ func decodeValue(val reflect.Value, enc any) error { | |||
| fval := val.FieldByName(name) | |||
| switch name { | |||
| case "Type", "Pos", "End": | |||
| // Type is already used above. Pos and End came from method calls. | |||
| // Type is already used above. [syntax.Node.Pos] and [syntax.Node.End] came from method calls. | |||
There was a problem hiding this comment.
these refer to the JSON key names, not the methods. undoing these changes.
Thanks for the review,and telling why you excluded some of them |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
zero code changes, only godoc update