100% agree.
On top of that I would like this to hook into Documenter.jl, so it can read the docstring and nicely format it for me when rendering the docs. Python docs usually do this and it looks much cleaner in my opinion.
Related topics
| Topic | Replies | Views | Activity | |
|---|---|---|---|---|
| Some thoughts on improving basic function documentation | 51 | 2401 | October 21, 2024 | |
| The challenges of documenting generic functions | 24 | 1495 | August 29, 2023 | |
| Argument-specific docstrings or comments | 23 | 3007 | March 2, 2026 | |
| Documentation: how should names be qualified? | 3 | 518 | October 11, 2022 | |
| Is there a Julia Style Guide? | 23 | 3368 | April 29, 2022 |