Add a first wave of docstrings to core parts of the library #68

Merged

meliurwen merged 12 commits from 66-feature-add-a-first-wave-of-docstrings-to-core-parts-of-the-library into dev 2 years ago

Author	SHA1	Message	Date
Meliurwen	0ae2168a94	Commented out some prints in chi2 compare matrices	2 years ago
Meliurwen	832922922a	Fixed error in chi2 compare matrices docstring	2 years ago
Meliurwen	3522e1b6f6	Small formatting fix and rewording of a docstring	2 years ago
Meliurwen	245b3b5d45	Replaced the static docstrings at the crate level in `lib.rs` withthe external file `README.md`	2 years ago
Meliurwen	08623e28d4	Added various docstrings notes to all rust modules	2 years ago
Meliurwen	f7165d0345	Added docstrings to `networks.rs`	2 years ago
Meliurwen	9ca8973550	Harmonized some docstrings in `params.rs`	2 years ago
Meliurwen	064b582833	Added docstrings for the chi-squared test	2 years ago
Meliurwen	2153f46758	Fixed small lint problem and added a paragraph to the README	2 years ago
Meliurwen	ccced92149	Fixed some docstrings in `params.rs`	2 years ago
Meliurwen	616d5ec3d5	Fixed and prettified some imprecisions to old docstrings and added new ones in `ctbn.rs`	2 years ago
Meliurwen	672de56c31	Added a brief description of the project in form of docstrings at the crate level	2 years ago