alihan/textual
1
0
Fork 0
mirror of https://github.com/Textualize/textual.git synced 2025-10-17 02:38:12 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add a note about best practice of the user of discover

Browse Source
This commit is contained in:
Dave Pearson
2024-02-14 10:08:54 +00:00
parent cbb44bb50c
commit 4f6f15a066
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/guide/command_palette.md
View File

@@ -104,6 +104,11 @@ In the example above, the callback is a lambda which calls the `open_file` metho
The [`discover`][textual.command.Provider.discover] method is responsible for providing results (or *hits*) that should be shown to the user when the command palette input is empty;
this is to aid in command discoverability.
!!! note
Because `discover` hits are shown the moment the command palette is opened, these should ideally be quick to generate;
commands that might take time to generate are best left for `search` -- use `discover` to help the user easily find the most important commands.
`discover` is similar to `search` but with the difference that no search value is passed to it, and it should *yield* instances of [`DiscoveryHit`][textual.command.DiscoveryHit].
There is no matching and no match score is needed.
The [`DiscoveryHit`][textual.command.DiscoveryHit] contains information about how the hit should be displayed, and an optional help string;