sh-ih
commented
1 year ago 🗺️ Nice work! Some comments:
- Repository Your repository is organized but it could be improved by adding a map folder to store your image.png file, instead of leaving it at the root, as well as your_map.html currently inside Notebooks. Also, a data folder where to store the csv files currently inside the Notebook folder.
Work on making informative commit messages, instead of nice and done. Right now you are working alone but, as part of a team, you need to clearly state what you are adding to the project.
- README Your readme is very informative. You did a great job with taking the reader along your whole process and how you developed the project. It is also a great idea to include the map with your chosen office.
Always be very mindful of a project's requirements. In this case, part of the deliverables was: “You must provide lat and long for the new office proposals.”. You gave us the name of the company occupying the office, but not the coordinates.
It may seem like a small thing, but you don’t want to be in the middle of your presentation searching your notebooks (because you did include it there) to get longitude and latitude of the city center after your CEO asked you for them right there and then. Better to include it right here in the README and on your slides, and not only on the html map.
-
Code You are showing a great understanding of functions and that’s great. One way to go even further is to add docstrings to your functions, explaining the goal of each function, which arguments takes as input and the expected output. Your notebook is organized, but I would suggest you don’t work your whole project in just one notebook. More complex projects are easier to maintain when you have one notebook for scraping, another one for EDA and so on.
-
Maps You can organize your repo with a specific folder for maps or include them inside a folder of images. Right now you have a png at the root level and the html inside notebooks. The map is clear. You chose appropriate icons to show what exists around the chosen location
https://github.com/marcoayora/Project-3-marco