dariocurr opened a new pull request, #20310:
URL: https://github.com/apache/datafusion/pull/20310
# Pull Request Description
## Which issue does this PR close?
<!--
We generally require a GitHub issue to be filed for all bug fixes and
enhancements and this helps us generate change logs for our releases. You can
link an issue to this PR using the GitHub syntax. For example `Closes #123`
indicates that this PR will close issue #123.
-->
- Closes #.
## Rationale for this change
<!--
Why are you proposing this change? If this is already explained clearly in
the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand your
changes and offer better suggestions for fixes.
-->
When the CLI prompt is empty, users have no indication of how to get help or
exit. Showing a subtle gray hint (e.g. `\? for help, \q to quit`) on an empty
line improves discoverability without changing any existing behavior.
## What changes are included in this PR?
<!--
There is no need to duplicate the description in the issue here but it is
sometimes worth providing a summary of the individual changes in this PR.
-->
- Implement `Hinter::hint` on `CliHelper` so that when the current line is
empty, a default hint is shown (e.g. `\? for help, \q to quit`) in gray.
- Add a `DEFAULT_HINT_SUGGESTION` constant and use it for the hint text.
- Expose the highlighter’s `Color` type and its methods as `pub(crate)` and
add `Color::gray()` for styling the hint.
## Are these changes tested?
<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code
If tests are not included in your PR, please explain why (for example, are
they covered by existing tests)?
-->
No new tests were added; the change is a small UI hint.
Manual testing: start the CLI and confirm the hint appears on an empty line
and disappears when typing. Happy to add tests if the project expects them for
this behavior.
## Are there any user-facing changes?
<!--
If there are user-facing changes then we may require documentation to be
updated before approving the PR.
-->
Yes. When the input line is empty, users now see a gray hint: `\? for help,
\q to quit`. No API or CLI flag changes. Documentation could optionally mention
this hint in the CLI docs if the project documents REPL UX.
<!--
If there are any breaking changes to public APIs, please add the `api
change` label.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
