I knew I could set the docstring (and played with it) but I did not realize that would work when the function is imported from a module!
Thank you, Ramit Ramit Prasad | JPMorgan Chase Investment Bank | Currencies Technology 712 Main Street | Houston, TX 77002 work phone: 713 - 216 - 5423 -----Original Message----- From: [email protected] [mailto:[email protected]] On Behalf Of Alan Gauld Sent: Thursday, May 26, 2011 7:20 PM To: [email protected] Subject: Re: [Tutor] nested / concatenated function docstrings? "Prasad, Ramit" <[email protected]> wrote > I would like to have the docstring for function first also > contain the docstring for second because it should > support/pass any argument second contains. You can explicitly set the docstring by assigning to __doc__: >>> def f(): ... '''here is f's doc string ''' ... return 42 ... >>> def g(): ... return f() + 10 ... >>> g.__doc__ = "Here is g's help\n" + f.__doc__ >>> help(g) >>> help(g) Help on function g in module __main__: g() Here is g's help here is f's doc string >>> There may be a more elegant way but that seems to work... -- Alan Gauld Author of the Learn to Program web site http://www.alan-g.me.uk/ _______________________________________________ Tutor maillist - [email protected] To unsubscribe or change subscription options: http://mail.python.org/mailman/listinfo/tutor This communication is for informational purposes only. It is not intended as an offer or solicitation for the purchase or sale of any financial instrument or as an official confirmation of any transaction. All market prices, data and other information are not warranted as to completeness or accuracy and are subject to change without notice. Any comments or statements made herein do not necessarily reflect those of JPMorgan Chase & Co., its subsidiaries and affiliates. This transmission may contain information that is privileged, confidential, legally privileged, and/or exempt from disclosure under applicable law. If you are not the intended recipient, you are hereby notified that any disclosure, copying, distribution, or use of the information contained herein (including any reliance thereon) is STRICTLY PROHIBITED. Although this transmission and any attachments are believed to be free of any virus or other defect that might affect any computer system into which it is received and opened, it is the responsibility of the recipient to ensure that it is virus free and no responsibility is accepted by JPMorgan Chase & Co., its subsidiaries and affiliates, as applicable, for any loss or damage arising in any way from its use. If you received this transmission in error, please immediately contact the sender and destroy the material in its entirety, whether in electronic or hard copy format. Thank you. Please refer to http://www.jpmorgan.com/pages/disclosures for disclosures relating to European legal entities. _______________________________________________ Tutor maillist - [email protected] To unsubscribe or change subscription options: http://mail.python.org/mailman/listinfo/tutor
