Suggestions for the ipython notebook NTL_Beirut20210505.ipynb

GvdDool-SiS / NightTimeLight

Article and Notebooks related to Night Time Light Analysis

1 stars 0 forks source link

Open sunayana opened 3 years ago

sunayana commented 3 years ago

All the hardcoded paths can be moved to an .env file and can be loaded using load_dotenv() method of the python-dotenv library. Since other users may not have the same paths.

In general python docstring can be used to comment a function: https://realpython.com/documenting-python-code/ It is useful when using the functions later for getting the documentation.

@GvdDool In general the code was understandable. I did not have more time to dig further.

GvdDool-SiS commented 3 years ago

Thanks Sunayana, I will look into both suggestions:

you are right; having an .env file might be useful because everyone has a different logic to store the input data.
creating a docstring is on my to-do list, I just have to figure out how to set it up (I know it's not complicated), but that's the reason for the text blocks in the function section of the notebook; I was thinking about converting them to docstrings after editing the code.