-
-
Should add module docstrings to all files to explain more what they do and have some links to external docs.
-
Historically, there was no validation on how docstrings were written. Some conventions were usually followed, but as the project grew, it was more difficult to ensure that all the API documentation pa…
-
I'd love to have a better answer for this kind of thing: https://stackoverflow.com/questions/58990657/python-how-do-i-find-inspect-what-kind-of-arguments-a-function-accepts
Some thoughts:
* The …
-
It is very helpful to have an `Examples` section in the docstring of functions.
Specially for `gammapy.maps` and `gammapy.estimators` where its often unclear what slices need to be passed as argument…
-
Hello everyone, as I already hinted at the last meeting, I'm working on [docstub](https://github.com/lagru/docstub), to turn scikit-image's docstrings into type stubs. It's still very much a [prototyp…
lagru updated
2 months ago
-
I'm trying to use CZPowGates as examples for some documentation and I run into an IndexError when trying to do a simple Qualtran style implementation of just a single CZPowGate:
```
from qualtran im…
-
Develop a system for writing docstrings that is comprehensive and will be of use to future developers, and for overwriting class methods for implementing behaviour.
Section in docs that use autodoc…
-
- [ ] Docstrings dynamic?
https://github.com/lnccbrown/HSSM/blob/2b8fadbd1098c54e449ba95dbec963eb7d5a4617/src/hssm/param.py#L132-L133
- [ ] Almost the same logic. Unify in helper method with a `…
-
And host API docs on the website