Skip to content
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

Add API reference to docs #342

Open
Supreeeme opened this issue Nov 10, 2022 · 1 comment
Open

Add API reference to docs #342

Supreeeme opened this issue Nov 10, 2022 · 1 comment

Comments

@Supreeeme
Copy link

Supreeeme commented Nov 10, 2022

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.

@akinsho
Copy link
Owner

akinsho commented Nov 16, 2022

@Supreeeme in general, any function prefixed with __ is private. I don't mind a PR exposing this, but I haven't done it yet because generally I'd rather avoid having to maintain yet more documentation. The large majority of function other than toggle aren't really necessary for most users.

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

No branches or pull requests

2 participants