search

python-lsp / python-lsp-server

Fork of the python-language-server project, maintained by the Spyder IDE team and the community
MIT License
1.75k stars 187 forks source link

docstring-to-markdown as optional dependency #537

Open npradeep357 opened 3 months ago

npradeep357 commented 3 months ago

Hi ,I'm using python-lsp-server as part of our custom IDE and in our case we don't need the docstring-to-markdown for the following reasons:

Any thoughts on this are welcome. Thank you.

ccordoba12 commented 3 months ago

@krassowski, what do you think about this one?

krassowski commented 3 months ago

'docstring-to-markdown' comes with LGPL license

Please note the "L" in front. It means you can license your own code which uses docstring-to-markdown any way you like :shrug: I find a lot of people confuse GPL with LGPL.

we have our own custom converter which does it for us.

I think the docstring-to-markdown provides a good user experience and should be included by default so it should not be optional in the sense of moving it to extras (i.e. not require installation with python-lsp-server[all] but be installed with just python-lsp-server). However, it would be reasonable to have an entry point that allows to swap docstring-to-markdown to a preferred docstring converter of choice (including a converter that does nothing).

ccordoba12 commented 3 months ago

I think the docstring-to-markdown provides a good user experience and should be included by default so it should not be optional in the sense of moving it to extras (i.e. not require installation with python-lsp-server[all] but be installed with just python-lsp-server).

Agreed.

However, it would be reasonable to have an entry point that allows to swap docstring-to-markdown to a preferred docstring converter of choice (including a converter that does nothing).

I agree with this too. @npradeep357, up to you if you want to submit a PR to implement that because it won't offer any benefit to us.