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

[Feature Request] Allow passing filters to --doc #2630

Open
Stanzilla opened this issue Apr 23, 2024 · 0 comments
Open

[Feature Request] Allow passing filters to --doc #2630

Stanzilla opened this issue Apr 23, 2024 · 0 comments

Comments

@Stanzilla
Copy link

It would be very nice if we were able to pass filters to the --doc command to only document specific namespaces.

Example:

lua-language-server --doc="../../.." --doc-filter="MyNameSpace" --doc_out_path="."

Would only output documentation for MyNameSpace and every member like MyNameSpace.Private etc.

For the json output formal I can do this easily via something like

jq '[.[] | select(.name | index("MyNameSpace") != -1)]' doc.json > output.json but for the markdown output, it would be fairly difficult.

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

1 participant