doyubkim / fluid-engine-dev

Fluid simulation engine for computer graphics applications

Home Page:https://fluidenginedevelopment.org/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Make more detailed Python API documentation

PavelBlend opened this issue · comments

Hello.

I often use python api documentation.
And I noticed that the descriptions of the accepted parameters of the classes were gone.
You have to look for these parameters in the source code in the src\python\ folder.
It is advisable to make sure that there is no need to look for information in the source code.
For all Python API information to be available here:
https://fluidenginedevelopment.org/pdoc/

And I would like to have descriptions of the types of received parameters.

You could also change the marchingCubes function.
You need to give it named parameters.

And one could split the python API documentation into many pages, instead of one.
And add the ability to search all pages of the Python API documentation.

And questions:

  1. Is absolutely everything in python API the same as in C ++ API? Or are there things that aren't there?

  2. Where can I read parameter descriptions? What are they responsible for? Is there documentation on all parameters? For example, what is the positionSmoothingFactor parameter of the AnisotropicPointsToImplicit3 class responsible for?