Add docstring to all functions

nelse003 / exhaustive_search

Testing exhaustive search algorithms for crystallographic occupancy refinement and surrounding problems

0 stars 0 forks source link

Add docstring to all functions #11

Open nelse003 opened 6 years ago

nelse003 commented 6 years ago

A a descriptive docstring to all functions

[x] Exhaustive_search.py
[ ] Repeating_exhaustive_search.py
[x] Select_occupancy_groups.py
[ ] Plot_exhasutive_search.py

nelse003 commented 6 years ago

Consider adding types: According to https://www.jetbrains.com/help/pycharm/using-docstrings-to-specify-types.html

In the style of http://docutils.sourceforge.net/docs/user/rst/quickstart.html

nelse003 commented 6 years ago

Added basic docstrings to exhasutive search and select occupancy groups. The parameter descriptions and types are not complete but protyped. 24ca93b3a7d7d34186bbd2e2d0fdbe6ca8d10add