Custom Docstrings in Python

Question

How would create a custom docstring in python? Would you just say __nameofdocstring__ or is there something else you should do?

Is it possible to create a new docstring for a certain .py file? I want to write __notes__ = "blah blah blah", but just saying that statement won't work.

What do you mean by "custom docstring"? It sounds like you have something specific in mind, but you haven't made it clear what it is. — user2357112, Oct 10 '18 at 01:12
do you want to modify an existing third-party function, or is this for a function that you wrote? — Paul H, Oct 10 '18 at 01:14
@PaulH Can you explain what you think my question is currently? — DS_Secret Studios, Oct 10 '18 at 01:19
@PaulH How would you make a new docstring that is not built into the python standard library? — DS_Secret Studios, Oct 10 '18 at 01:20
I have no clue. It doesn't make sense to me yet. I don't know what you're starting with and your destination is even less clear — Paul H, Oct 10 '18 at 01:20
do you want this new docstring to persist in the stdlib every time your start python? — Paul H, Oct 10 '18 at 01:21
@PaulH Yes, but no. I just want a new docstring in my current python file. — DS_Secret Studios, Oct 10 '18 at 01:23
i thought I was starting to understand what you wanted, but that last comment lost me. Explain what you have, what you want, and how you expect it to be used — Paul H, Oct 10 '18 at 01:24
(and by "explain", I mean: edit the question to explicitly state that information with examples) — Paul H, Oct 10 '18 at 01:25

Lukas · Accepted Answer · 2018-10-10T01:29:31.203

Docstring Example

Let's show how an example of a multi-line docstring:

def my_function():
"""Do nothing, but document it.

No, really, it doesn't do anything.
"""
pass

Let's see how this would look like when we print it

print my_function.__doc__

Do nothing, but document it.

    No, really, it doesn't do anything.

Declaration of docstrings

The following Python file shows the declaration of docstrings within a python source file:

"""
Assuming this is file mymodule.py, then this string, being the
first statement in the file, will become the "mymodule" module's
docstring when the file is imported.
"""

class MyClass(object):
    """The class's docstring"""

    def my_method(self):
        """The method's docstring"""

def my_function():
    """The function's docstring"""

How to access the Docstring

The following is an interactive session showing how the docstrings may be accessed

>>> import mymodule
>>> help(mymodule)

Assuming this is file mymodule.py then this string, being the first statement in the file will become the mymodule modules docstring when the file is imported.

>>> help(mymodule.MyClass)
The class's docstring

>>> help(mymodule.MyClass.my_method)
The method's docstring

>>> help(mymodule.my_function)
The function's docstring

"Docstring", named for "documentation". That's all. You can document what your functions are doing. — Lukas, Oct 10 '18 at 01:30
If you're problem is solved please consider marking an answer as correct (whether it be mine, your own or someone else's) so future helper gremlins like yours truly can safely skip the question. Thanks! — Lukas, Oct 10 '18 at 01:31

Custom Docstrings in Python

1 Answers1

Docstring Example

Declaration of docstrings

How to access the Docstring