akinsho / akinsho/toggleterm.nvim

Add API reference to docs

Aperta
#342 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Lua
Stelle
5.6k
Fork
206
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

The docs say:
> WARNING: do not use any of the private functionality of the terminal or other non-public parts of the API as these can change in the future.

However, to me it's not really clear everything that is part of the public API. For example, there are functions that take a Terminal object, but it's not immediately obvious what fields of a Terminal can be accessed.
From briefly glancing at the code (to figure out what fields Terminals have) it's already pretty well commented. I don't mind throwing up a PR for this myself, I was just more curious of where you'd think it would be best to put this documentation (ideally so that it's accessible from `:h toggleterm.txt`), as well as determining which parts of the API are intended to be public.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.