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

Tidy up a suggested edit to the discover docs

Browse Source
This commit is contained in:
Dave Pearson
2024-02-15 09:37:47 +00:00
parent efb8b48347
commit 3971449c16
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/guide/command_palette.md
View File

@@ -110,9 +110,11 @@ this is to aid in command discoverability.
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 these differences:
- `discover` accepts no parameters (instead of the search value);
- `discover` yields instances of [`DiscoveryHit`][textual.command.DiscoveryHit]` (instead of instances of xxx);
- discovery hits are sorted in ascending alphabetical order because there is no matching and no match score is generated.
- `discover` accepts no parameters (instead of the search value)
- `discover` yields instances of [`DiscoveryHit`][textual.command.DiscoveryHit] (instead of instances of [`Hit`][textual.command.Hit])
- discovery hits are sorted in ascending alphabetical order because there is no matching and no match score is generated
Instances of [`DiscoveryHit`][textual.command.DiscoveryHit] contain information about how the hit should be displayed, an optional help string, and a callback which will be run if the user selects that command.
### shutdown method