Skip to content

Option --doc_out_path no longer optional #3073

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Closed
AndreasMatthias opened this issue Feb 12, 2025 · 3 comments · Fixed by #3076
Closed

Option --doc_out_path no longer optional #3073

AndreasMatthias opened this issue Feb 12, 2025 · 3 comments · Fixed by #3076

Comments

@AndreasMatthias
Copy link
Contributor

Option --doc_out_path was initially implemented to be an optional argument. But since #2821 it is mandatory. You can no longer use --doc without --doc_out_path. I.e. you get an unsatisfying error with

lua-language-server --doc=.

I'd like to fix this and make --doc_out_path optional again.

What do you think is a reasonable default path?

Originally the default path of doc.json was the log path of LuaLS (aka LOGPATH in the code).
Now I'm pondering on changing the default path of doc.json to be the current directory.
Is this reasonable? What do you think? Any objections?

@rhys-vdw
Copy link

I think current directory makes sense, but I think it should log a message that informs the user of the option so they can learn to include it.

@tomlau10
Copy link
Contributor

but I think it should log a message that informs the user of the option

There will be a --help soon: #3065
though initially it will only include content from luals wiki, which maybe outdated.
For example the --num_threads (multi thread check: #2638) is not documented.

@AndreasMatthias
Copy link
Contributor Author

I could update the --doc... related help message in #3065.
What's the best way to do so? A PR to @lewis6991 repository?

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants