Repository navigation
Link to the docs/tutorial/... on library import (inital load) #151
Description
Task Title
Task: Include a logging to make it easy to find the tutorial page
Task Description
This issue will...
{{ message }}
Task: Include a logging to make it easy to find the tutorial page
This issue will...
Activity
#151 add turorial while importing
Merge pull request #152 from PythonPredictions/151-include-turorial-w…
sandervh14 commentedon Mar 9, 2023
This was actually a VERY good idea.
I'd like to suggest though to use the opportunity to also to link to the documentation, the DFT presentation for details on inner workings and maybe also just the github URL for people that downloaded the library by instruction of someone else.
[-]include turorial while importing[/-][+]Link to the docs/tutorial/... on library import (inital load)[/+]ZlaTanskY commentedon Mar 24, 2023
Why do we add documentation in the code while this is already available in the readme on the github mainpage? (see also this link)
In my opinion we should separate the place where we put code and where we put documentation, this to avoid clutter whenever we rerun a notebook or a script.
patrickleonardy commentedon Apr 3, 2023
It is true that this pops up each time a script is run but in the end it is just a little message under the imports cell. I would not mind as this can be minimized in a notebook . However, I am wondering if this can cause problems when using cobra in production. If this is the case, I suggest that we take it out and include it in
help(cobra)or?cobra. Like this it only shows when the user wants to see it.patrickleonardy commentedon Apr 3, 2023
Sorry did close this issue on accident
ZlaTanskY commentedon Apr 4, 2023
I agree that including it in
help(cobra)would be a better solutionsandervh14 commentedon Apr 6, 2023
Fine for me too!
Revert "#151 add turorial while importing"
patrickleonardy commentedon Apr 6, 2023
okay I'll add it then in the
__init__.pyfile like this it shows up by callinghelp(cobra). To add the Powerpoint presentation I will convert it to a pdf and upload it to GitHub if this is fine for you.