Skip to content

Rework Completions and Externs chapters #1505

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.

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

Merged
merged 3 commits into from
Aug 12, 2024

Conversation

NotTheDr01ds
Copy link
Contributor

@NotTheDr01ds NotTheDr01ds commented Aug 12, 2024

Started out implementing #1044 and #788.

  • Moved Completions chapter ahead of Externs. This reduces duplication since Externs can take advantage of Completions.
  • Extensive wording cleanup
  • Document that completers must return a list
  • Document that the default completer is for files/directories
  • Document that the default completer can be suppressed using a command that returns an empty list
  • Mention the menu-indicator and how to change it
  • Clarify that changes to completers require reparsing the command-to-be-completed
  • Added documentation on the $position argument (should close Document arguments to autocomplete commands #788)
  • Updated example to use cleaner match syntax
  • Use Tab in place of tab (at some point I'd like to update the style on this)
  • The External chapter used git push as the example, and said it was in the default config (which it isn't, at least not any longer) -- Changed example to be a simple ssh example that demonstrates just the key points, much more succinctly.
  • Changed glob to path in the second example (should close There seems not to be any document about path as a type. #1044)
  • Changed warning for # description to just a tip
  • Added limitation note regarding caret sigil
  • Added limitation note regarding -longoption syntax not being supported

@fdncred
Copy link
Contributor

fdncred commented Aug 12, 2024

looks good, thanks! one small typo above.

Co-authored-by: Darren Schroeder <343840+fdncred@users.noreply.github.com>
@NotTheDr01ds
Copy link
Contributor Author

Thanks! Fixed.

@fdncred fdncred merged commit 7bc7ea5 into nushell:main Aug 12, 2024
2 checks passed
@fdncred
Copy link
Contributor

fdncred commented Aug 12, 2024

Thanks

@NotTheDr01ds NotTheDr01ds deleted the completion-updates branch August 17, 2024 15:08
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.

There seems not to be any document about path as a type. Document arguments to autocomplete commands
2 participants