Skip to content

sort: use fmt.Scan in ExampleSearch_guessingGame to handle leftover n… - #80734

Open
AkariH wants to merge 1 commit into
golang:masterfrom
AkariH:fix-sort-example-guessinggame
Open

sort: use fmt.Scan in ExampleSearch_guessingGame to handle leftover n…#80734
AkariH wants to merge 1 commit into
golang:masterfrom
AkariH:fix-sort-example-guessinggame

Conversation

@AkariH

@AkariH AkariH commented Aug 5, 2026

Copy link
Copy Markdown

What does this PR do?

This PR fixes an interactive input glitch in ExampleSearch_guessingGame within the sort.Search documentation example in src/sort/search.go.

Root Cause & Problem

Currently, ExampleSearch_guessingGame uses fmt.Scanf("%s", &s) inside the binary search closure passed to sort.Search:

func GuessingGame() {
    var s string
    fmt.Printf("Pick an integer from 0 to 100.\n")
    answer := sort.Search(100, func(i int) bool {
        fmt.Printf("Is your number <= %d? ", i)
        fmt.Scanf("%s", &s)
        return s != "" && s[0] == 'y'
    })
    fmt.Printf("Your number is %d.\n", answer)
}

When executed in a real interactive TTY session:

  1. Entering 'y' followed by Enter leaves the newline character '\n' in os.Stdin's buffer.
  2. In subsequent binary search iterations of sort.Search, fmt.Scanf("%s", &s) reads the leftover '\n', fails to parse a non-empty string token, and returns immediately without waiting for keyboard input.
  3. As a result, all remaining interactive prompts in the search process are skipped without user interaction.

Solution

Replace fmt.Scanf("%s", &s) with fmt.Scan(&s).

fmt.Scan automatically consumes and discards leading whitespace and newline characters ('\n'), ensuring that each iteration correctly blocks and waits for user input.

@google-cla

google-cla Bot commented Aug 5, 2026

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@AkariH
AkariH force-pushed the fix-sort-example-guessinggame branch from d072a01 to 43b129f Compare August 5, 2026 10:18
@gopherbot

Copy link
Copy Markdown
Contributor

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

Please visit Gerrit at https://go-review.googlesource.com/c/go/+/810760.

Important tips:

  • Don't comment on this PR. All discussion takes place in Gerrit.
  • You need a Gmail or other Google account to log in to Gerrit.
  • To change your code in response to feedback:
    • Push a new commit to the branch used by your GitHub PR.
    • A new "patch set" will then appear in Gerrit.
    • Respond to each comment by marking as Done in Gerrit if implemented as suggested. You can alternatively write a reply.
    • Critical: you must click the blue Reply button near the top to publish your Gerrit responses.
    • Multiple commits in the PR will be squashed by GerritBot.
  • The title and description of the GitHub PR are used to construct the final commit message.
    • Edit these as needed via the GitHub web interface (not via Gerrit or git).
    • You should word wrap the PR description at ~76 characters unless you need longer lines (e.g., for tables or URLs).
  • See the Sending a change via GitHub and Reviews sections of the Contribution Guide as well as the FAQ for details.

@gopherbot

Copy link
Copy Markdown
Contributor

Message from Gopher Robot:

Patch Set 1:

(1 comment)


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

@gopherbot

Copy link
Copy Markdown
Contributor

Message from Gopher Robot:

Patch Set 1:

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

Next steps:
A maintainer will review your change and provide feedback. See
https://go.dev/doc/contribute#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 or adds a tag like "wait-release", it means that this CL will be
reviewed as part of the next development cycle. See https://go.dev/s/release
for more details.


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

@gopherbot

Copy link
Copy Markdown
Contributor

Message from Cocoa:

Patch Set 1:

(1 comment)


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

@gopherbot

Copy link
Copy Markdown
Contributor

Message from Cocoa:

Patch Set 1:

(1 comment)


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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants