Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feedback on: API Tutorial 01 - Download data from the Open Energy Platform using the API #233

Closed
han-f opened this issue Jul 17, 2024 · 1 comment
Assignees

Comments

@han-f
Copy link
Contributor

han-f commented Jul 17, 2024

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.

@han-f han-f added the bug Something isn't working label Jul 17, 2024
@han-f
Copy link
Contributor Author

han-f commented Jul 17, 2024

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

@han-f han-f added SIROP-WP3 and removed bug Something isn't working labels Jul 17, 2024
wingechr added a commit that referenced this issue Aug 1, 2024
@wingechr wingechr closed this as completed Aug 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants