File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -398,7 +398,25 @@ The text between the two sets of triple double quotes is called a docstring and
398398contains the documentation for the function. It does nothing when the function
399399is running and is therefore not necessary, but it is good practice to include
400400docstrings as a reminder of what the code does. Docstrings in functions also
401- become part of their 'official' documentation:
401+ become part of their 'official' documentation, and we can see them by typing
402+ ` help(function_name) ` :
403+
404+ ~~~
405+ help(one_year_csv_writer)
406+ ~~~
407+ {: .language-python }
408+
409+ ~~~
410+ Help on function one_year_csv_writer in module __main__:
411+
412+ one_year_csv_writer(this_year, all_data)
413+ Writes a csv file for data from a given year.
414+ this_year -- year for which data is extracted
415+ all_data -- DataFrame with multi-year data
416+ ~~~
417+ {: .output }
418+
419+ Or, when working in the Jupyter environment, adding a ` ? ` (question mark) after the function name:
402420
403421~~~
404422one_year_csv_writer?
You can’t perform that action at this time.
0 commit comments