OK, maybe I will open an issue. The obvious concern is how to avoid duplicating ...

merlincorey · on July 16, 2015

You'd probably want to make a metaclass that handled the manipulation of __doc__ for shared verbs if you didn't want to duplicate the data too much.

Myrmornis · on July 16, 2015

OK, but in requests they are top-level functions, not methods. Is there anything wrong with the below? I don't think I've seen it done.

  __shared_docstring_content = """
  bar
  baz
  """

  def f():
      "f docstring"
      pass

  f.__doc__ += __shared_docstring_content


  def g():
      "g docstring"
      pass

  g.__doc__ += __shared_docstring_content

andreasvc · on July 16, 2015

I would do simply """f docstring\n%s""" % _shared_docstring, no need for a separate concatenation. However, I wonder whether sphinx would handle this.

shoyer · on July 17, 2015

This sort of thing works fine. We use it for pandas all the time.

aaronchall · on July 17, 2015

Pandas does this, and I think it works well, even if it's not entirely transparent in the source.