Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.python > #9172 > unrolled thread

Function docstring as a local variable

Back to article view | Back to comp.lang.python

Contents

  Function docstring as a local variable Tim Johnson <tim@johnsons-web.com> - 2011-07-10 09:41 -0800
    Re: Function docstring as a local variable rantingrick <rantingrick@gmail.com> - 2011-07-10 10:44 -0700
      Re: Function docstring as a local variable "Colin J. Williams" <cjw@ncf.ca> - 2011-07-10 18:28 -0400
        Re: Function docstring as a local variable Ben Finney <ben+python@benfinney.id.au> - 2011-07-11 09:48 +1000
      Re: Function docstring as a local variable Corey Richardson <kb1pkl@aim.com> - 2011-07-10 19:00 -0400
        Re: Function docstring as a local variable Steven D'Aprano <steve+comp.lang.python@pearwood.info> - 2011-07-11 11:54 +1000
        Re: Function docstring as a local variable alex23 <wuwei23@gmail.com> - 2011-07-10 21:05 -0700

#9172 — Function docstring as a local variable

Consider the following:
## code
def test():
    """This is my docstring"""
    print(??)  ## can I print the docstring above?
## /code
It possible for a function to print it's own docstring?

thanks
(pointers to docs could be sufficient)
-- 
Tim 
tim at johnsons-web dot com or akwebsoft dot com
http://www.akwebsoft.com

[toc] | [next] | [standalone]

#9173

On Jul 10, 12:41 pm, Tim Johnson <t...@johnsons-web.com> wrote:
> It possible for a function to print it's own docstring?

def f():
   """docstring"""
   print "docstring"

any questions?

[toc] | [prev] | [next] | [standalone]

#9189

On 10-Jul-11 13:44 PM, rantingrick wrote:
> On Jul 10, 12:41 pm, Tim Johnson<t...@johnsons-web.com>  wrote:
>> It possible for a function to print it's own docstring?
>
> def f():
>     """docstring"""
>     print "docstring"
>
> any questions?

Try:

def f():
      ds= """docstring"""
      print ds
 >

Colin W.

[toc] | [prev] | [next] | [standalone]

#9204

"Colin J. Williams" <cjw@ncf.ca> writes:

> On 10-Jul-11 13:44 PM, rantingrick wrote:
> > On Jul 10, 12:41 pm, Tim Johnson<t...@johnsons-web.com>  wrote:
> >> It possible for a function to print it's own docstring?
> >
> > def f():
> >     """docstring"""
> >     print "docstring"
>
> Try:
>
> def f():
>      ds= """docstring"""
>      print ds

The OP wants the function to print its own docstring, which your example
does not do. You've defined a function with an empty docstring.

    >>> def foo():
    ...     ds = "The Larch"
    ...     print ds
    ... 
    >>> foo.__doc__
    >>>

-- 
 \       “Firmness in decision is often merely a form of stupidity. It |
  `\        indicates an inability to think the same thing out twice.” |
_o__)                                                —Henry L. Mencken |
Ben Finney

[toc] | [prev] | [next] | [standalone]

#9196

[Multipart message — attachments visible in raw view] — view raw

Excerpts from Colin J. Williams's message of Sun Jul 10 18:28:15 -0400 2011:
> Try:
> 
> def f():
>       ds= """docstring"""
>       print ds

That doesn't actually make a docstring, though. It makes a string object and
points the name ds at it. Do you know what a docstring is?

def foo():
    """I am a docstring"""
    pass

def bar():
    ds = "I am not a docstring!"

def baz():
    "I am a docstring too!"
    pass

def qux():
    'And even me! Quote type don't matter (besides style)'
     pass
-- 
Corey Richardson
  "Those who deny freedom to others, deserve it not for themselves"
     -- Abraham Lincoln

[toc] | [prev] | [next] | [standalone]

#9214

On Mon, 11 Jul 2011 09:00 am Corey Richardson wrote:

> Excerpts from Colin J. Williams's message of Sun Jul 10 18:28:15 -0400
> 2011:
>> Try:
>> 
>> def f():
>>       ds= """docstring"""
>>       print ds
> 
> That doesn't actually make a docstring, though. It makes a string object
> and points the name ds at it. Do you know what a docstring is?


Colin might not be aware of why docstrings are useful, and arbitrary local
variables ds="""docstring""" are not.


def f1():
    """This is my documentation string.

    Imagine this has actual useful information.
    """

def f2():
    dc = """This is my documentation string.

    Imagine this has actual useful information.
    """


Now, at the interactive interpreter, call:

help(f1)
help(f2)



-- 
Steven

[toc] | [prev] | [next] | [standalone]

#9219

On Jul 11, 9:00 am, Corey Richardson <kb1...@aim.com> wrote:
> def qux():
>     'And even me! Quote type don't matter (besides style)'

Well, style and the presence of the string literal notation in the
quoted text :)

[toc] | [prev] | [standalone]

Back to top | Article view | comp.lang.python

csiph-web