From 19fd7449bb3665ec3b2c55b176a90977554185d9 Mon Sep 17 00:00:00 2001 From: toravest Date: Fri, 23 May 2025 10:40:53 +0200 Subject: [PATCH] add function documentation to setup.py --- src/my_package/setup.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/src/my_package/setup.py b/src/my_package/setup.py index 0f18581..055b122 100644 --- a/src/my_package/setup.py +++ b/src/my_package/setup.py @@ -1,6 +1,12 @@ import os def set_up_API(): + ''' + This function is getting input from the user for their API-information. + The function creates, and add the API_KEY and API_EMAIL. When everything is set, + the API is good, and can be used to retrive data in the notebooks. + ''' + # Define the path to the .env file at the root of the project env_filepath = os.path.join(os.path.dirname(__file__), "../../.env") @@ -22,4 +28,7 @@ def set_up_API(): print("You can now run the notebooks, and get data!") print("Add your info to OpenWeatherMap.com, and the function will create and add the info to env.") -set_up_API() \ No newline at end of file +set_up_API() + +# This prints the documentation for the functions written inside '''these''' +# print(set_up_API.__doc__) \ No newline at end of file