Skip to content

go/doc: fix detection of whole file examples #37730

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
Closed
wants to merge 1 commit into from
Closed

go/doc: fix detection of whole file examples #37730

wants to merge 1 commit into from

Conversation

flyingmutant
Copy link
Contributor

@flyingmutant flyingmutant commented Mar 7, 2020 •
edited
Loading

After CL 211357 (commit 499dc1c),
hasTests and numDecl were not updated properly for function
declarations with parameters, which affected the whole file
example detection logic. This caused examples like

package foo_test

func Foo(x int) {
}

func Example() {
	fmt.Println("Hello, world!")
	// Output: Hello, world!
}

to not be detected as whole file ones.

@googlebot googlebot added the cla: yes Used by googlebot to label PRs as having a valid CLA. The text of this label should not change. label Mar 7, 2020
@gopherbot
Copy link
Contributor

This PR (HEAD: 1d4092f) has been imported to Gerrit for code review.

Please visit https://go-review.googlesource.com/c/go/+/222477 to see it.

Tip: You can toggle comments from me using the comments slash command (e.g. /comments off)
See the Wiki page for more info

@gopherbot
Copy link
Contributor

Message from Gobot Gobot:

Patch Set 1:

Congratulations on opening your first change. Thank you for your contribution!

Next steps:
Within the next week or so, a maintainer will review your change and provide
feedback. See https://golang.org/doc/contribute.html#review for more info and
tips to get your patch through code review.

Most changes in the Go project go through a few rounds of revision. This can be
surprising to people new to the project. The careful, iterative review process
is our way of helping mentor contributors and ensuring that their contributions
have a lasting impact.

During May-July and Nov-Jan the Go project is in a code freeze, during which
little code gets reviewed or merged. If a reviewer responds with a comment like
R=go1.11, it means that this CL will be reviewed as part of the next development
cycle. See https://golang.org/s/release for more details.

Please don’t reply on this GitHub thread. Visit golang.org/cl/222477.
After addressing review feedback, remember to publish your drafts!

@flyingmutant
Copy link
Contributor Author

What are the steps to get this reviewed? It has been almost a month with no updates.

@gopherbot
Copy link
Contributor

Message from Agniva De Sarker:

Patch Set 1:

(2 comments)

Sorry for the delay. Here is a first pass.

Please don’t reply on this GitHub thread. Visit golang.org/cl/222477.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Gregory Petrosyan:

Patch Set 1:

(2 comments)

Please don’t reply on this GitHub thread. Visit golang.org/cl/222477.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Agniva De Sarker:

Patch Set 1:

(2 comments)

Please don’t reply on this GitHub thread. Visit golang.org/cl/222477.
After addressing review feedback, remember to publish your drafts!

@flyingmutant
go/doc: fix detection of whole file examples
cc71c31 
After CL 211357 (commit 499dc1c),
hasTests and numDecl were not updated properly for function
declarations with parameters, which affected the whole file
example detection logic. This caused examples like

	package foo_test

	func Foo(x int) {
	}

	func Example() {
		fmt.Println("Hello, world!")
		// Output: Hello, world!
	}

to not be detected as whole file ones.
@gopherbot
Copy link
Contributor

This PR (HEAD: cc71c31) has been imported to Gerrit for code review.

Please visit https://go-review.googlesource.com/c/go/+/222477 to see it.

Tip: You can toggle comments from me using the comments slash command (e.g. /comments off)
See the Wiki page for more info

@gopherbot
Copy link
Contributor

Message from Gregory Petrosyan:

Patch Set 3:

(1 comment)

I've updated the commit message.

Please don’t reply on this GitHub thread. Visit golang.org/cl/222477.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Agniva De Sarker:

Patch Set 3: Run-TryBot+1 Code-Review+1

Please don’t reply on this GitHub thread. Visit golang.org/cl/222477.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Gobot Gobot:

Patch Set 3:

TryBots beginning. Status page: https://farmer.golang.org/try?commit=8d14cb06

Please don’t reply on this GitHub thread. Visit golang.org/cl/222477.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Gobot Gobot:

Patch Set 3: TryBot-Result+1

TryBots are happy.

Please don’t reply on this GitHub thread. Visit golang.org/cl/222477.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Gregory Petrosyan:

Patch Set 3:

Is there anything I can do to move this CL forward?

Please don’t reply on this GitHub thread. Visit golang.org/cl/222477.
After addressing review feedback, remember to publish your drafts!

gopherbot pushed a commit that referenced this pull request Apr 15, 2020
@flyingmutant @griesemer
go/doc: fix detection of whole file examples
c4961dc 
After CL 211357 (commit 499dc1c),
hasTests and numDecl were not updated properly for function
declarations with parameters, which affected the whole file
example detection logic. This caused examples like

	package foo_test

	func Foo(x int) {
	}

	func Example() {
		fmt.Println("Hello, world!")
		// Output: Hello, world!
	}

to not be detected as whole file ones.

Change-Id: I9ebd47e52d7ee9d91eb6f8e0257511de69b2a402
GitHub-Last-Rev: cc71c31
GitHub-Pull-Request: #37730
Reviewed-on: https://go-review.googlesource.com/c/go/+/222477
Reviewed-by: Agniva De Sarker <[email protected]>
Reviewed-by: Robert Griesemer <[email protected]>
Run-TryBot: Agniva De Sarker <[email protected]>
TryBot-Result: Gobot Gobot <[email protected]>
@gopherbot
Copy link
Contributor

This PR is being closed because golang.org/cl/222477 has been merged.

@gopherbot gopherbot closed this Apr 15, 2020
@dmitshur dmitshur mentioned this pull request Apr 17, 2020
Closed
@flyingmutant flyingmutant deleted the example-fix branch April 17, 2020 16:33
gopherbot pushed a commit that referenced this pull request May 11, 2020
@flyingmutant @dmitshur
[release-branch.go1.14] go/doc: fix detection of whole file examples
14c92c5 
After CL 211357 (commit 499dc1c),
hasTests and numDecl were not updated properly for function
declarations with parameters, which affected the whole file
example detection logic. This caused examples like

	package foo_test

	func Foo(x int) {
	}

	func Example() {
		fmt.Println("Hello, world!")
		// Output: Hello, world!
	}

to not be detected as whole file ones.

Fixes #38418.
For #38409.

Change-Id: I9ebd47e52d7ee9d91eb6f8e0257511de69b2a402
GitHub-Last-Rev: cc71c31
GitHub-Pull-Request: #37730
Reviewed-on: https://go-review.googlesource.com/c/go/+/222477
Reviewed-by: Agniva De Sarker <[email protected]>
Reviewed-by: Robert Griesemer <[email protected]>
Run-TryBot: Agniva De Sarker <[email protected]>
TryBot-Result: Gobot Gobot <[email protected]>
(cherry picked from commit c4961dc)
Reviewed-on: https://go-review.googlesource.com/c/go/+/232868
Run-TryBot: Dmitri Shuralyov <[email protected]>
Reviewed-by: Gregory Petrosyan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
cla: yes Used by googlebot to label PRs as having a valid CLA. The text of this label should not change.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@flyingmutant @gopherbot @googlebot