#28 @params ignored for **kwargs

closed-works-for-me
nobody
epytext (18)
5
2003-09-18
2003-09-18
No

I have a function that takes **kwargs and want to document some of them. If I have @param markup, a warning is generated that is is an unknown parameter, and no HTML is output.

I would prefer that it output the markup.

===============
def func(**kwargs):
"@param one: something i understand"
pass
===============

Discussion

  • Edward Loper

    Edward Loper - 2003-09-18

    Logged In: YES
    user_id=195958

    Use the "@keyword" tag to mark keyword parameters that are
    not explicitly specified in the declaration:

    def func(**kwargs):
    "@keyword one: something i understand"

     
  • Edward Loper

    Edward Loper - 2003-09-18
    • labels: --> epytext
    • status: open --> closed-works-for-me
     

Log in to post a comment.

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:

JavaScript is required for this form.





No, thanks