You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The idea of this issue was to create material focused on introduction to students how to read documentation. Discussing how to find documentation online and how the Jupyter magic ? gives documentation for a given function. @alexsquires may have covered this in #63
@VarunK21 I think the goal here is to explain how to access docstrings using the operator ? in Jupyter Notebooks and how to rely on the documentation online.
@arm61 then I would like to discuss about reading the documentation online in a seperate Document
If you can allow me to do so ??
Is it the (shift +tab) method or the official online documentations uploaded by python on their websites??
I am not really sure what you mean by "shift+tab" (that doesn't do anything on my Jupyter notebook).
However, yes this would include the documentation that numpy/scipy/etc include online, and explaining how to find it.
@arm61 (shift + tab) in any inbuilt function gives you the tooltip i.e., what all arguments that inbuilt function of python takes and what it returns .
Should i write a documentation which includes what all is available online on numpy/scipy/etc and how to find it ....?
@VarunK21 the aim is to create something that will help students understand how documentation can be found and understood.
If you write something to this affect, open a pull request and we (yourself, myself and other contributors) can work together to make it as useful as possible.
Sure @arm61 , I will try me best to write an effective documentation which would help everyone in reading and understanding the documentations in an effective way.
Activity
VarunK21 commentedon May 19, 2020
Do we need to build a new documentation or what ?? I am interested in contributing but doesnt know what exactly to do ..
If you could help @arm61
arm61 commentedon May 19, 2020
The idea of this issue was to create material focused on introduction to students how to read documentation. Discussing how to find documentation online and how the Jupyter magic
?gives documentation for a given function. @alexsquires may have covered this in #63RMeli commentedon May 19, 2020
@VarunK21 I think the goal here is to explain how to access
docstringsusing the operator?in Jupyter Notebooks and how to rely on the documentation online.VarunK21 commentedon May 19, 2020
So the documentation has already been made by alexsquires I guess...
@arm61
arm61 commentedon May 19, 2020
I am not sure, I haven't had a look at PR #63.
Just to be clear, it isn't that documentation for the project needs to be written, rather a section introducing how to read documentation to students.
arm61 commentedon May 19, 2020
Having a quick look at that PR, it looks like the
?notation is covered. However there is no discussion about finding documentation online.VarunK21 commentedon May 19, 2020
@arm61 then I would like to discuss about reading the documentation online in a seperate Document
If you can allow me to do so ??
Is it the (shift +tab) method or the official online documentations uploaded by python on their websites??
arm61 commentedon May 20, 2020
I am not really sure what you mean by "shift+tab" (that doesn't do anything on my Jupyter notebook).
However, yes this would include the documentation that numpy/scipy/etc include online, and explaining how to find it.
VarunK21 commentedon May 20, 2020
@arm61 (shift + tab) in any inbuilt function gives you the tooltip i.e., what all arguments that inbuilt function of python takes and what it returns .
Should i write a documentation which includes what all is available online on numpy/scipy/etc and how to find it ....?
arm61 commentedon May 20, 2020
Ah right, that is "shift+enter" for me.
Please feel free to write a section introducing how to find documentation online.
arm61 commentedon May 20, 2020
@VarunK21 the aim is to create something that will help students understand how documentation can be found and understood.
If you write something to this affect, open a pull request and we (yourself, myself and other contributors) can work together to make it as useful as possible.
VarunK21 commentedon May 20, 2020
Sure @arm61 , I will try me best to write an effective documentation which would help everyone in reading and understanding the documentations in an effective way.
VarunK21 commentedon May 21, 2020
@arm61 I have forked the repository and added a new file named "More-on-Documentation". Please have a look at it .
VarunK21 commentedon May 21, 2020
And do suggest me the changes you want me to do in it .