Comments (5)
I think sphinx uses the func.__doc__
after import, to catch changes done automatically. Since the wrapped function uses functools.wrap
it will retain the doc string.
from sisl.
Agreed, for now I have added a simple thing. It would be great if the decorator added this automatically. :)
from sisl.
The function that appears on the docs is the original one or the one returned by the decorator?
from sisl.
The function that appears on the docs is the original one or the one returned by the decorator?
The decorator does not change the docs currently, so it is the wrapped functions doc-string.
from sisl.
Yes, but I mean what sphinx catches is the wrapped function, not the raw text of the function definition?
from sisl.
Related Issues (20)
- `only` or `what`? HOT 11
- numpy.typing and sisl requirements HOT 2
- Geometry collections -- trajectories HOT 13
- Symmetry groups HOT 1
- Sites class HOT 8
- nsc should not belong to Lattice HOT 18
- fdfSileSiesta.includes() crashed when there were blank lines in the fdf file HOT 1
- nodes tests not ran on codecov HOT 2
- Computing density on grid from density matrix in .DM file HOT 6
- Search function in online documentation HOT 4
- Read/write of TSDE files HOT 5
- Merge all matrix pyx files into one
- Documentation HOT 1
- Should we change to `furo` theme? HOT 5
- Realspace self energy for non collinear
- BZ.replace -- trs point and offset
- sisl unit conversion (siesta units to sisl units) HOT 5
- local variable 'Ef' referenced before assignment HOT 1
- Reading HSX fails HOT 27
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from sisl.