What does the """...""" in a function do?

Question

3.00/5 (1 vote)

See more:

What do the three " mean in a function (in python) with a message in it?
Can't we use a # for such a report? Here is an example of what I n:

def make_sandwich(*items):
    """Make a sandwich with the given items."""
    print("\nI'll make you a great sandwich:")
    for item in items:
        print("  ...adding " + item + " to your sandwich.")
    print("Your sandwich is ready!")

So what i mean is the first sentence under de def ("""Make a sandwish with the given items.""")

Thank you

What I have tried:

Tried to find it on google but no sucess

Posted 7-Mar-19 7:22am

Thijsdm

Updated 7-Mar-19 9:24am

Add a Solution

3 solutions

Solution 3

Thank you guys, i'm new to programming:) But i think you noticed that haha

Posted 7-Mar-19 9:25am

Thijsdm

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Afzaal Ahmad Zeeshan · Accepted Answer · 2019-03-07T08:31:00

That is a question that includes 2 questions, one about the data type, and second the purpose of that placement.

First of, as Solution 1 answers, that is a string definition. In Python, you are not restrained to use a single quote to create a string, you can use multiple ways and this triple double quote is one of them.

And as far as the placement is concerned, that placement makes this string a comment for the function. Thus, anyone trying to use the function will be able to see this as a helper comment. For that, see here What is the proper way to comment functions in python? - Stack Overflow[^]

OriginalGriff · Accepted Answer · 2019-03-07T08:01:00

Solution 1

Your google-fu needs some work - a trivial google found loads: python three double quotes - Google Search[^]
And straight to here: Python Strings | Python Education | Google Developers[^]

Posted 7-Mar-19 8:01am

OriginalGriff