steamapi icon indicating copy to clipboard operation
steamapi copied to clipboard

decorated functions do not have sensible signatures/docstrings

Open ghost opened this issue 11 years ago • 2 comments

https://micheles.googlecode.com/hg/decorator/documentation3.html#definitions goes a bit into the problems it causes, same for the functools library

more practically: http://i.imgur.com/2vt7Awi.png (IPython) | http://i.imgur.com/kWO7AOK.png (dreampie

neither responses explain the interface of the actual function/class

this is probably fairly low priority, but it can be useful for IDEs / custom interpreters

might not be practical/useful once auto-populated interfaces become used more (unless the interfaces provide documentation)

ghost avatar Oct 21 '14 08:10 ghost

Oh, forgot about this decorator issue. Does this screw up any other functions/classes? I'll fix this, but APIConnection will soon be retired for an instance-based solution (like APIInterface in the "autopopulated-interfaces" branch) rather than a singleton-based solution.

smiley avatar Oct 21 '14 10:10 smiley

It only affects the APIConnection from the looks of things.

Considering that is only just the 1 object, and it is documented in the examples, (and the impending retirement),definitely a low priority

ghost avatar Oct 21 '14 11:10 ghost