akinsho / akinsho/toggleterm.nvim
Add API reference to docs
- Ngôn ngữ chính
- Lua
- Star
- 5.6k
- Fork
- 206
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
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.
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Đánh giá
Issue này chưa được đánh giá.