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

Code Documentation #22

Open
HenftyKnight opened this issue Nov 9, 2021 · 4 comments
Open

Code Documentation #22

HenftyKnight opened this issue Nov 9, 2021 · 4 comments

Comments

@HenftyKnight
Copy link

HenftyKnight commented Nov 9, 2021

Awesome Work! Thank you for creating such an amazing tutorial.
Just one note though, in your Beyond This Tutorial -> Code Documentation
You might want to change the help(plt) -> help(plt.plot) as we have imported
the matplotlib.pyplot as plt so inorder to run the help command for it's functions
help(plt.) would lead to the correct result.

Thank you

#-----------------------------------------------------------
Code documentation

The code is fairly well documented and you can quickly access a specific command from within a python session:

import matplotlib.pyplot as plt
help(plt.plot)
Help on function plot in module matplotlib.pyplot:

plot(*args, **kwargs)
Plot lines and/or markers to the
:class:~matplotlib.axes.Axes. args is a variable length
argument, allowing for multiple x, y pairs with an
optional format string. For example, each of the following is
legal::

   plot(x, y)         # plot x and y using default line style and color
   plot(x, y, 'bo')   # plot x and y using blue circle markers
   plot(y)            # plot y using x as index array 0..N-1
   plot(y, 'r+')      # ditto, but with red plusses

If x and/or y is 2-dimensional, then the corresponding columns
will be plotted.
...
#----------------------------------------------------------

@rougier
Copy link
Owner

rougier commented Nov 22, 2021

Oh thanks. Can you make a PR?

@HenftyKnight
Copy link
Author

HenftyKnight commented Nov 22, 2021 via email

@HenftyKnight
Copy link
Author

HenftyKnight commented Nov 22, 2021 via email

@rougier
Copy link
Owner

rougier commented Nov 22, 2021

@HenftyKnight Sorry for the acronym (PR) and you're right, I meant pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants