Repository navigation
naming conventions #58
Description
I think it would be beneficial to change some method names to both increase usability, but also create natural ways of extending the functionality. Please comment on the ideas and provide your own.
helper functions
Currently the helper functions are called .get_all_regions and get_statistics. It might be better to have a uniform naming, i.e. all in both or none of them.
query builder results
Currently there are methods .results and .meta_data in the query builder. I would suggest renaming this to include a verb. Probably .get_results and .get_meta_data, which would make it more apparent that these are methods. Furthermore it would free up the other names to be attributes or properties, which can be used to store results in the query, reprocess fetched results with different formatting etc. By using properties one could even retain the current behavior and have .results fetch results, i.e. call .get_results when it is called for the first time, but then return stored results afterwards.
Activity
aylinsgl commentedon Jul 8, 2020
If im not mistaken it seems like the function
get_all_regionswas renamed toget_regionsnow, but in the Read Me it still saysget_all_regionsfor all of the examples :) just came upon this when i wanted to play around with this a little bit and thought i would bring it up. really cool package by the way!KonradUdoHannes commentedon Jul 10, 2020
Thank you for pointing that out. We already release 0.3.0 on pypi but are still in the process of updating the readme and the readthedocs documentation. We hope to release an updated version of these this weekend and definitely appreciate any current and future feedback on the matter very much.