search

ferencberes / ethp2psim

Ethereum P2P network privacy simulator
https://arxiv.org/abs/2306.15024
GNU General Public License v3.0
6 stars 2 forks source link

Write more detailed doctrings #14

Closed ferencberes closed 1 year ago

ferencberes commented 1 year ago

Returns, Raises, See also, Notes, References, Examples sections are NEEDED!

Good examples: https://hplgit.github.io/teamods/sphinx_api/html/sphinx_api.html#how-to-format-doc-strings https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html

ferencberes commented 1 year ago

Most of the code have docstring in the documentation.