I find it slightly goofy that in the documentation of the API I click the finite_difference module and then I have to select the _finite_difference file to see the actual docs. Yet in __init__.py in the same folder you import the public methods, which makes them available as if they were at that level of the file hierarchy. The docs should agree with the import structure, and users don't need to know about the existence of particular _method.py files.
I've devised a way to fix it, which I'm implementing now.
I find it slightly goofy that in the documentation of the API I click the
finite_differencemodule and then I have to select the_finite_differencefile to see the actual docs. Yet in__init__.pyin the same folder you import the public methods, which makes them available as if they were at that level of the file hierarchy. The docs should agree with the import structure, and users don't need to know about the existence of particular_method.pyfiles.I've devised a way to fix it, which I'm implementing now.