Update documentation to reflect API changes #2439
Conversation
doc/source/dotnet.rst
Outdated
| @@ -15,7 +15,9 @@ These classes include PyObject, PyList, PyDict, PyTuple, etc. | |||
| At a very high level, to embed Python in your application one will need | |||
| to: | |||
|
|
|||
| - Reference ``Python.Runtime.dll`` (e.g. via a ``PackageReference``) | |||
| - Reference ``Python.Runtime.dll`` (e.g. via a ``PackageReference``, | |||
| the ``Runtime.PythonDLL`` property or the ``PYTHONNET_PYDLL`` | |||
There was a problem hiding this comment.
This is wrong. The Runtime.PythonDLL and PYTHONNET_PYDLL reference libpython*.so/dylib or python*.dll.
There was a problem hiding this comment.
Ah, I didn't know that there's a difference. But since it's now mandatory to reference a Python DLL, I think it's a good idea to mention it here. Maybe as a separate bullet point?
| @@ -85,6 +85,7 @@ Example | |||
|
|
|||
| static void Main(string[] args) | |||
| { | |||
| Runtime.PythonDLL = "python38.dll"; | |||
There was a problem hiding this comment.
I really don't want to give people the idea that this is the way to go. Maybe we can point them toward (or include) https://github.com/losttech/WhichPython? Maybe give a note above to set the PYTHONNET_PYDLL environment variable?
There was a problem hiding this comment.
Yeah, I wasn't really keen on this either, but I figured since this was one of the examples given in the paragraph above it that this would be at least acceptable.
I also thought about mentioning the env var, but I didn't want to clutter this example with a comment (at least not without the permisson of you guys)
|
I've noticed that .. doxygennamespace:: Python::Runtime
:members:
:outline:to enable it? Apologies, I'm new to RST and I get errors about missing |
|
@filmor Is this PR still relevant? |
What does this implement/fix? Explain your changes.
Adds the now mandatory use of setting the Python DLL in C# to the README and documentation
Does this close any currently open issues?
Fixes #2433
Any other comments?
Also updated the use of
PyModule.Importin the wiki with https://github.com/pythonnet/pythonnet/wiki/Threading/aee4b778efd079911d1b771c8b59ba5bd7dd156dChecklist
Check all those that are applicable and complete.
AUTHORSCHANGELOG