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

Make more detailed Python API documentation #278

Open
PavelBlend opened this issue Dec 21, 2019 · 0 comments
Open

Make more detailed Python API documentation #278

PavelBlend opened this issue Dec 21, 2019 · 0 comments

Comments

@PavelBlend
Copy link
Contributor

PavelBlend commented Dec 21, 2019

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?

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