han-f
commented
1 month ago Description of the issue
From comment in #165 :
Feedback for API Tutorial 01 (as i didn't find a separate issue for feedback on it):
In general the code worked following the steps, sometimes a bit more clarity (e.g. information on what the used functions do in the) using more detailed (#)comments in the code or additional links would be helpfull.
At first the code did not work due to internal firewall restriction of our network (it worked well when connected through WLAN) - a hint on this possibility would have saved me quite some time of error finding. In general I suggest adding a few more links for completeness & easier understanding for non experienced programmers, e.g.:
e.g. link the same link as before for json serializable data e.g. overall introduction to the request package (where one can find further information e.g. the main function req.get() explained to understand the code) e.g. where filters and introduction to HTTP query string parameters
cc @flohrreija-oeko
Please provide feedback on the tutorial https://openenergyplatform.github.io/academy/tutorials/01_api/01_api_download/ in comments below. Feedback can include pointing out errors (such as broken links, things that do not work as described) any suggestions for improvements, things that you expected but missed, etc.