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 a mechanism to include additional document in the generated JSDocs for Vim script functions #280

Open
mityu opened this issue Dec 25, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@mityu
Copy link
Contributor

mityu commented Dec 25, 2024

Is your feature request related to a problem?

Related to #279.

In function module, we cannot write additional notes in the JSDocs generated from Vim/Neovim's documents because they'll be all replaced by the document generator (deno-denops-std/.scripts/gen-functions/gen-functions.ts).

Since such additional document sometimes beneficial, e.g., write a note about better helper function, difference in behavior between Vim's builtin functions and denops-std's ones or etc, it must be useful to add a mechanism to include additional document in the generated JSDocs for functions under deno-denops-std/function/*.

Describe the solution you'd like

Introduce a new marker or something to indicate the following statement/paragraph is an additional note so that it won't be removed through automatic JSDoc generations.

Additional context

@mityu mityu added the enhancement New feature or request label Dec 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant