matplotlib-tutorial icon indicating copy to clipboard operation
matplotlib-tutorial copied to clipboard

Code Documentation

Open HenftyKnight opened this issue 4 years ago • 4 comments

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. ... #----------------------------------------------------------

HenftyKnight avatar Nov 09 '21 18:11 HenftyKnight

Oh thanks. Can you make a PR?

rougier avatar Nov 22 '21 12:11 rougier

I am sorry, I don't know the acronym PR here. If you please let me know what it is, I'll do it for you.

Thanks Rush

On Mon., Nov. 22, 2021, 05:26 Nicolas P. Rougier, @.***> wrote:

Oh thanks. Can you make a PR?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/rougier/matplotlib-tutorial/issues/22#issuecomment-975470816, or unsubscribe https://github.com/notifications/unsubscribe-auth/AQAWNKPK3CJIP6Y23377SNDUNIZG3ANCNFSM5HWA7JGA . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

HenftyKnight avatar Nov 22 '21 14:11 HenftyKnight

Oh I got it, I'll make a pull request asap.

Cheers Rush

On Mon., Nov. 22, 2021, 05:26 Nicolas P. Rougier, @.***> wrote:

Oh thanks. Can you make a PR?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/rougier/matplotlib-tutorial/issues/22#issuecomment-975470816, or unsubscribe https://github.com/notifications/unsubscribe-auth/AQAWNKPK3CJIP6Y23377SNDUNIZG3ANCNFSM5HWA7JGA . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

HenftyKnight avatar Nov 22 '21 14:11 HenftyKnight

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

rougier avatar Nov 22 '21 17:11 rougier