search

creanero / stellar_matchmaker

MIT License
1 stars 1 forks source link

Finish Docstrings for all functions, classes and methods #30

Open creanero opened 4 months ago

creanero commented 4 months ago

Add detailed docstrings to the code. This will be reflected in the documentation (including readthedocs) once we use sphinx. Currently missing docstrings: observation.py methods stellar_matchmaker.py functions run_query() and output_data() stellar_param.py methods

Once these are written, run documentation commands Comment the import statements in stellar_matchmaker.py python -m twine upload dist/* Uncomment the import statements in stellar_matchmaker.py

creanero commented 3 months ago

@tyoo37 to do docstrings in stellar_matchmaker.py as part of the refactor @astrovidee to handle the other docstrings.

Once theses are completed, we can revisit the twine/readthedocs integration