Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

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


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


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




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: