sisl icon indicating copy to clipboard operation
sisl copied to clipboard

Documentation issues for SileBound

Open zerothi opened this issue 8 months ago • 1 comments

Describe the bug The documentation for the sliced decorated methods does not get through.

I am currently not aware of exactly why, they are properly using the functools.update_wrapper calls, and I would have expected at least something to happen.

Now help(method) works.

Links to a problematic case:

https://zerothi.github.io/sisl/api/io/generated/sisl.io.orca.stdoutSileORCA.html#sisl.io.orca.stdoutSileORCA.read_charge

Now

>>> help(sisl.io.orca.stdoutSileORCA.read_charge)

shows the right thing...

Perhaps an extension could solve the problem? https://github.com/numba/numba/issues/5755#issuecomment-683650903

zerothi avatar Oct 26 '23 20:10 zerothi