Menu ▾ ▴

Different types of Docstrings

Please post to StackOverflow with PyDev tag
Steve Lianoglou
2007-03-07
2013-03-15

  • Steve Lianoglou

    Steve Lianoglou - 2007-03-07

    Hi again,

    Is it somehow possible to leverage PyDev's brains to tweak the syntax of the docstrings?

    For instance, I like how I can hit Cmd-1 at the end of a method that I'm writing and have it insert the docstrings and 'slots' for the parameters in the method signature, however I've kind of settled on using reStructuredText docstrings which look a bit different.

    So, for example, if I have :
    def method(one,two):

    Instead of it creating:

    """

    @param one:
    @param two:
    """

    What would it take to create:

    """

    :Parameters:
    `one`:
    `two`:
    """

    Thanks,
    -steve

     

    • Fabio Zadrozny

      Fabio Zadrozny - 2007-03-07

      Should be possible... please open a feature request for that.

      Cheers,

      Fabio

       
MongoDB Logo MongoDB