sammyette
/
Hilbish
mirror of https://github.com/Hilbis/Hilbish
2
2
Fork 0
Code Issues Releases Wiki Activity
Hilbish/docs/api/hilbish/hilbish.completions.md

77 lines
2.4 KiB
Markdown
Raw Normal View History

refactor!: rework docs and doc command (#218) changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website. all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-15 04:00:54 +00:00
---
docs: add detailed parameter listing, change interface to modules there are a few changes here - documentation of each parameter separately has been added to the generated text docs - interfaces have been renamed to modules. this was honestly a pointless and confusing distinction (interfaces are tables for modules that are lua modules). it also makes it so that (formerly) interfaces and modules line up with each other on the doc list im not sure what else i did, these are old changes
2023-08-26 15:30:51 +00:00
title: Module hilbish.completions
refactor!: rework docs and doc command (#218) changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website. all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-15 04:00:54 +00:00
description: tab completions
layout: doc
menu:
docs:
parent: "API"
---
## Introduction
The completions interface deals with tab completions.
## Functions
docs: make various style changes - add a table that lists module functions - add highlight when jumping to a function - separators
2023-09-02 18:18:40 +00:00
|||
|----|----|
|<a href="#completions.call">call(name, query, ctx, fields) -> completionGroups (table), prefix (string)</a>|Calls a completer function. This is mainly used to call|
|<a href="#completions.handler">handler(line, pos)</a>|The handler function is the callback for tab completion in Hilbish.|
|<a href="#completions.bins">bins(query, ctx, fields) -> entries (table), prefix (string)</a>|Returns binary/executale completion candidates based on the provided query.|
|<a href="#completions.files">files(query, ctx, fields) -> entries (table), prefix (string)</a>|Returns file completion candidates based on the provided query.|
<hr><div id='completions.call'>
<h4 class='heading'>
hilbish.completions.call(name, query, ctx, fields) -> completionGroups (table), prefix (string)
<a href="#completions.call" class='heading-link'>
<i class="fas fa-paperclip"></i>
</a>
</h4>
refactor!: rework docs and doc command (#218) changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website. all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-15 04:00:54 +00:00
Calls a completer function. This is mainly used to call
a command completer, which will have a `name` in the form
docs: [ci] generate new docs
2023-02-07 22:19:24 +00:00
of `command.name`, example: `command.git`.
You can check `doc completions` for info on the `completionGroups` return value.
docs: add detailed parameter listing, change interface to modules there are a few changes here - documentation of each parameter separately has been added to the generated text docs - interfaces have been renamed to modules. this was honestly a pointless and confusing distinction (interfaces are tables for modules that are lua modules). it also makes it so that (formerly) interfaces and modules line up with each other on the doc list im not sure what else i did, these are old changes
2023-08-26 15:30:51 +00:00
#### Parameters
This function has no parameters.
docs: turn properties list into a table also fix member functions causing a spam of separators
2023-09-02 20:01:57 +00:00
</div>
<hr><div id='completions.handler'>
docs: make various style changes - add a table that lists module functions - add highlight when jumping to a function - separators
2023-09-02 18:18:40 +00:00
<h4 class='heading'>
hilbish.completions.handler(line, pos)
<a href="#completions.handler" class='heading-link'>
<i class="fas fa-paperclip"></i>
</a>
</h4>
refactor!: rework docs and doc command (#218) changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website. all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-15 04:00:54 +00:00
The handler function is the callback for tab completion in Hilbish.
You can check the completions doc for more info.
docs: add detailed parameter listing, change interface to modules there are a few changes here - documentation of each parameter separately has been added to the generated text docs - interfaces have been renamed to modules. this was honestly a pointless and confusing distinction (interfaces are tables for modules that are lua modules). it also makes it so that (formerly) interfaces and modules line up with each other on the doc list im not sure what else i did, these are old changes
2023-08-26 15:30:51 +00:00
#### Parameters
This function has no parameters.
docs: turn properties list into a table also fix member functions causing a spam of separators
2023-09-02 20:01:57 +00:00
</div>
<hr><div id='completions.bins'>
docs: make various style changes - add a table that lists module functions - add highlight when jumping to a function - separators
2023-09-02 18:18:40 +00:00
<h4 class='heading'>
hilbish.completions.bins(query, ctx, fields) -> entries (table), prefix (string)
<a href="#completions.bins" class='heading-link'>
<i class="fas fa-paperclip"></i>
</a>
</h4>
refactor!: rework docs and doc command (#218) changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website. all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-15 04:00:54 +00:00
Returns binary/executale completion candidates based on the provided query.
docs: add detailed parameter listing, change interface to modules there are a few changes here - documentation of each parameter separately has been added to the generated text docs - interfaces have been renamed to modules. this was honestly a pointless and confusing distinction (interfaces are tables for modules that are lua modules). it also makes it so that (formerly) interfaces and modules line up with each other on the doc list im not sure what else i did, these are old changes
2023-08-26 15:30:51 +00:00
#### Parameters
This function has no parameters.
docs: turn properties list into a table also fix member functions causing a spam of separators
2023-09-02 20:01:57 +00:00
</div>
<hr><div id='completions.files'>
docs: make various style changes - add a table that lists module functions - add highlight when jumping to a function - separators
2023-09-02 18:18:40 +00:00
<h4 class='heading'>
hilbish.completions.files(query, ctx, fields) -> entries (table), prefix (string)
<a href="#completions.files" class='heading-link'>
<i class="fas fa-paperclip"></i>
</a>
</h4>
refactor!: rework docs and doc command (#218) changes the actual file format of docs to markup since that's basically what we have been using in the first place. the docgen command has been modified to write markdown headings with the function name and yaml metadata for easy consumption by hugo for the website. all other docs have been moved to markdown as well this is the main reason this is a "breaking" change users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-15 04:00:54 +00:00
Returns file completion candidates based on the provided query.
docs: add detailed parameter listing, change interface to modules there are a few changes here - documentation of each parameter separately has been added to the generated text docs - interfaces have been renamed to modules. this was honestly a pointless and confusing distinction (interfaces are tables for modules that are lua modules). it also makes it so that (formerly) interfaces and modules line up with each other on the doc list im not sure what else i did, these are old changes
2023-08-26 15:30:51 +00:00
#### Parameters
This function has no parameters.
docs: turn properties list into a table also fix member functions causing a spam of separators
2023-09-02 20:01:57 +00:00
</div>