-
At the moment we don't run doc-strings on imported modules, but perhaps we should? Here's an example:
````cryptol
/**
```
"B"
```
*/
module B where
/* empty */
module A where
imp…
-
Some docstrings use the [google convention](https://github.com/google/styleguide/blob/gh-pages/pyguide.md#383-functions-and-methods): https://github.com/DiamondLightSource/httomo/blob/8a55c4dc62aae97d…
-
### Describe the bug
Kinda 2 issues I've seen, I think there are some improvements we can make to have the autocomplete powers of a Jupyter notebook.
There are some other issues but I saw on Discord …
-
### Discussed in https://github.com/PyO3/pyo3/discussions/4280
Originally posted by **djc** June 23, 2024
When I write a docstring on a `#[new] fn new()` method in a `#[pymethods]` `impl` bloc…
-
In Heptapod by @mattip on Feb 15, 2022, 12:41
This script
```
import builtins
import doctests
tests = doctest.DocTestFinder().find(builtins)
print(len(tests)
```
prints 447 on PyPy and 810 on CPytho…
-
**Describe the feature you'd like**
It might be nice to catch empty-line formatting like:
```
Args:
arg1: stuff
arg2: stuff
```
when it could be
```
Args:
arg1: stuff
a…
-
## 📚 Documentation
Consider the following example: `napari.viewer.Viewer` subclasses `napari.components.ViewerModel`. These two classes then share parameters (arguments for their `__init__` method)…
-
I notice that a lot of the functions don't have a docstring that shows up on `docs.rs`, but there is information available in comments in the implementation. Would it be welcome if I made a PR where I…
-
- [ ] Docstrings for all functions
- [ ] Minimally sufficient README
Questions:
- [ ] Organization of main code vs. scripts
-
Is there a way to get simple URLs to docstrings created with @autodocs? For example, this URL is very long because it encodes all type information:
https://sunnysuite.github.io/Sunny.jl/dev/library.…