Sign Up

Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.

Have an account? Sign In

Have an account? Sign In Now

Sign In

Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.

Sign Up Here

Forgot Password?

Don't have account, Sign Up Here

Forgot Password

Lost your password? Please enter your email address. You will receive a link and will create a new password via email.

Have an account? Sign In Now

You must login to ask a question.

Forgot Password?

Need An Account, Sign Up Here

Please briefly explain why you feel this question should be reported.

Please briefly explain why you feel this answer should be reported.

Please briefly explain why you feel this user should be reported.

Sign InSign Up

The Archive Base

The Archive Base Logo The Archive Base Logo

The Archive Base Navigation

  • SEARCH
  • Home
  • About Us
  • Blog
  • Contact Us
Search
Ask A Question

Mobile menu

Close
Ask a Question
  • Home
  • Add group
  • Groups page
  • Feed
  • User Profile
  • Communities
  • Questions
    • New Questions
    • Trending Questions
    • Must read Questions
    • Hot Questions
  • Polls
  • Tags
  • Badges
  • Buy Points
  • Users
  • Help
  • Buy Theme
  • SEARCH
Home/ Questions/Q 7061219
In Process

The Archive Base Latest Questions

Editorial Team
  • 0
Editorial Team
Asked: May 28, 20262026-05-28T04:26:50+00:00 2026-05-28T04:26:50+00:00

For example: def foo(length, width): Short desc. Arguments: length — A desc. width —

  • 0

For example:

def foo(length, width):
    """Short desc.

    Arguments:

    length -- A desc.
    width  -- A desc.
    """

Note how I have added an extra space after “width”.

  • 1 1 Answer
  • 0 Views
  • 0 Followers
  • 0
Share
  • Facebook
  • Report

Leave an answer
Cancel reply

You must login to add an answer.

Forgot Password?

Need An Account, Sign Up Here

1 Answer

  • Voted
  • Oldest
  • Recent
  • Random
  1. Editorial Team
    Editorial Team
    2026-05-28T04:26:50+00:00Added an answer on May 28, 2026 at 4:26 am

    I don’t think there is a convention about this. All PEP 257 says about the docstring of a function is

    The docstring for a function or method should summarize its behavior and document its arguments, return value(s), side effects, exceptions raised, and restrictions on when it can be called (all if applicable). Optional arguments should be indicated. It should be documented whether keyword arguments are part of the interface.

    The only example given in the PEP also doesn’t shed light on the matter:

    def complex(real=0.0, imag=0.0):
        """Form a complex number.
    
        Keyword arguments:
        real -- the real part (default 0.0)
        imag -- the imaginary part (default 0.0)
    
        """
        if imag == 0.0 and real == 0.0: return complex_zero
        ...
    

    I usually do align the dashes, but I don’t think there is a general convention.

    • 0
    • Reply
    • Share
      Share
      • Share on Facebook
      • Share on Twitter
      • Share on LinkedIn
      • Share on WhatsApp
      • Report

Sidebar

Related Questions

Suppose I have following code: def foo(s): A dummy function foo. For example: >>>
Have a look at the following Scala example: class A { def foo(x: Int):
For example, I have a function: def foo(a, b, c): pass Now I have
I have this code: class Mailer < ActionMailer::Base def foo recipients bar@example.com from foo@example.com
I will go straight to the example: class Foo: @execonce def initialize(self): print 'Called'
I have a generator that generates a series, for example: def triangle_nums(): '''Generates a
I have a ruby file as follows: module Example class Myclass def t_st Hello
I have the following example code: class A(object): def __init__(self, id): self.myid = id
I have a problem using docstrings with decorators. Given the following example: def decorator(f):
This is best explained with an example: file1.rb: def foo puts 123 end file2.rb:

Explore

  • Home
  • Add group
  • Groups page
  • Communities
  • Questions
    • New Questions
    • Trending Questions
    • Must read Questions
    • Hot Questions
  • Polls
  • Tags
  • Badges
  • Users
  • Help
  • SEARCH

Footer

© 2021 The Archive Base. All Rights Reserved
With Love by The Archive Base

Insert/edit link

Enter the destination URL

Or link to existing content

    No search term specified. Showing recent items. Search or use up and down arrow keys to select an item.