Custom documentation string stub

Is it possible to autoinsert documentation stub in PyCharm:

    @classmethod

    def fromID(cls, id):

        """Look up

        :param cls: a model by

        :param id:

        :return:

        """

But only "param" and "return" keywords will be inserted into stub.

I use type and rtype mostly in development, so it will be fine to specify format of documentation stub somewhere in configuration.

Can I change default stub template in PyCharm?

Thank you.

1 comment
Comment actions Permalink

Hello,

The default docstring template is not currently configurable. You're welcome

to file a feature request for adding an option to generate :type and :rtype

tags.

Is it possible to autoinsert documentation stub in PyCharm:

@classmethod

def fromID(cls, id):

"""Look up

:param cls: a model by

:param id:

:return:

"""

But only "param" and "return" keywords will be inserted into stub.

I use type and rtype mostly in development, so it will be fine to

specify format of documentation stub somewhere in configuration.

Can I change default stub template in PyCharm?

--

Dmitry Jemerov

Development Lead

JetBrains, Inc.

http://www.jetbrains.com/

"Develop with Pleasure!"

0

Please sign in to leave a comment.