it seems
__doc__
is useful to provide some documentation in, say, functions
This is true. In addition to functions, documentation can also be provided in modules. So, if you have a file named mymodule.py
like this:
"""This is the module docstring.""" def f(x): """This is the function docstring.""" return 2 * x
You can access its docstrings like this:
>>> import mymodule >>> mymodule.__doc__ 'This is the module docstring.' >>> mymodule.f.__doc__ 'This is the function docstring.'
Now, back to your question: what does print(__doc__)
do? Simply put: it prints the module docstring. If no docstring has been specified, __doc__
defaults to None
.
Related Posts:
- How to comment out a block of code in Python [duplicate]
- What are the most common Python docstring formats?
- How do I disable “missing docstring” warnings at a file-level in Pylint?
- TypeError: only size-1 arrays can be converted to Python scalars (matplotlib)
- Why do I get TypeError: can’t multiply sequence by non-int of type ‘float’?
- Writing a pandas DataFrame to CSV file
- When should I use uuid.uuid1() vs. uuid.uuid4() in python?
- ImportError: No module named tensorflow
- Best way to convert string to bytes in Python 3?
- How do you change the size of figures drawn with Matplotlib?
- PermissionError: [Errno 13] Permission denied
- Python Pandas Counting the Occurrences of a Specific value
- What does the c underscore expression `c_` do exactly?
- Count unique values per groups with Pandas
- Get unique values from a list in python [duplicate]
- How do you decode Base64 data in Python?
- Convert pandas Series to DataFrame
- TypeError: ‘type’ object is not subscriptable when indexing in to a dictionary
- Error: all the input array dimensions except for the concatenation axis must match exactly
- Expected 2D array, got 1D array instead error
- How to prevent errno 32 broken pipe?
- The equivalent of a GOTO in python [duplicate]
- tkinter gui with progress bar
- Invalid character in identifier
- if else in a list comprehension
- What does “\r” do in the following script?
- Convert list to tuple in Python
- Python: TypeError: object of type ‘NoneType’ has no len()
- anaconda – path environment variable in windows
- Pandas: ValueError: cannot convert float NaN to integer
- How to find all occurrences of an element in a list
- Cannot uninstall Tensorflow
- Add Legend to Seaborn point plot
- Get key by value in dictionary
- How to add multiple values to a dictionary key in python?
- Where can I find a list of the Flask SQLAlchemy Column types and options?
- How can I install Python’s pip3 on my Mac?
- convert json ipython notebook(.ipynb) to .py file
- how to update spyder on anaconda
- Django upgrading to 1.9 error “AppRegistryNotReady: Apps aren’t loaded yet.”
- Pygame Drawing a Rectangle
- Purpose of `numpy.log1p( )`?
- How do I change the figure size for a seaborn plot?
- How to use pyinstaller?
- use np.random.multinomial() in python
- pg_config executable not found
- Import error when trying to import tensorflow with gpu
- Removing Punctuation From Python List Items
- TypeError(“‘bool’ object is not iterable”,) when trying to return a Boolean
- “OverflowError: Python int too large to convert to C long” on windows but not mac
- Create a Pandas Dataframe by appending one row at a time
- ‘Pip’ is Not Recognized as an Internal or External Command windows 10 CMD
- Failed to load the native TensorFlow runtime – TensorFlow 2.1
- Using headers with the Python requests library’s get method
- How to sort a list/tuple of lists/tuples by the element at a given index?
- What can lead to “IOError: [Errno 9] Bad file descriptor” during os.system()?
- Shebang doesn’t work with python3
- How to truncate float values?
- How do I write a “tab” in Python?
- TypeError: ‘builtin_function_or_method’ object has no attribute ‘__getitem__’
- How to get a value from a cell of a dataframe?
- TypeError: can only concatenate str (not “float”) to str
- Converting a sentence to piglatin in Python
- How to use pygame.KEYDOWN to execute something every time through a loop while the key is held down?
- How to create an integer array in Python?
- Recursion in Python? RuntimeError: maximum recursion depth exceeded while calling a Python object
- Writing a dictionary to a csv file with one line for every ‘key: value’
- How to remove square brackets from list in Python?
- Errno 10061 : No connection could be made because the target machine actively refused it ( client – server )
- Python Error – TypeError: input expected at most 1 arguments, got 3 [duplicate]
- A general tree implementation?
- TypeError: expected string or buffer
- How to convert a file into a dictionary?
- Checking to see if a string is an integer or float
- Getting the name of a variable as a string
- can’t multiply sequence by non-int of type ‘list’
- cannot convert the series to
- Converting a RGB color tuple to a six digit code
- mean, nanmean and warning: Mean of empty slice
- SystemError: new style getargs format but argument is not a tuple?
- Python Set Comprehension
- ‘instancemethod’ object has no attribute ‘__getitem__’ with class variables
- Python/Scikit-Learn – Can’t handle mix of multiclass and continuous
- Sorting list of lists by the first element of each sub-list
- Install py2exe for python 2.7 over pip: this package requires Python 3.3 or later
- What is the correct format to write float value to file in Python
- How is Python’s List Implemented?
- ImportError: No module named IPython
- How to find length of digits in an integer?
- What exactly do “u” and “r” string flags do, and what are raw string literals?
- “E: Unable to locate package python3-pip”
- Eclipse, PyDev “Project interpreter not specified”
- “public” or “private” attribute in Python ? What is the best way?
- How to search for a string in text files?
- TypeError: ‘zip’ object is not subscriptable
- Pip: could not find a version. No matching distribution found
- Compare two columns using pandas
- ValueError: total size of new array must be unchanged
- Shuffle an array with python, randomize array item order with python
- No handlers could be found for logger