4

I'm writing some Python code that's being checked with pylint with the docparams extension. This requires documenting function parameters in their docstrings. I have a tendency to try to decompose functions as much as possible and end up with lots of functions that call other functions - often sharing many of the same parameters. This can lead to lots of redundant (copy-pasted) documentation in the docstrings. Is there a recommended way of dealing with this type of situation?

igal
  • 646
  • 7
  • 17

1 Answers1

3

I'm going to run into this same problem later while working on a Pyramid app, so I googled and found docrep. I think it'll satisfy both of our needs.

Jason Klas
  • 106
  • 5
  • The module you suggested ([docrep](http://docrep.readthedocs.io/en/latest/)) looks cool, but the docs say it only works with numpy-style docstrings. I actually have to stick to google-style docstrings, so I don't think I'll be able to use it on this project. – igal Jun 01 '18 at 20:17