Hi, thanks for a great utility!

I was thrilled when I just saw that autodoc_docstring_signature was to work 
in class methods (change log: http://sphinx-doc.org/changes.html#Release 
1.3b2 (released Dec 5, 2014)).
As I have decorators that take parameters, I can't use the decorator module.

Anyway, it doesn't work, however it doesn't seem that Sphinx *disregards* 
the signature, because if I put a signature there that conflicts with the 
actual signature of the method, for example has the wrong name, it silently 
fails to document the entire module.

This is a typical example of code that I am trying to document(part of a Python 
3 backend for MongoDB <https://github.com/OptimalBPM/mbe>):

@aop_has_right(get_node_rights)
def save(self, _document, _user):
    """save(self, _document, _user)

    Saves an MBE node descendant to the database.

    :param _document: The MBE node document to save.
    :param _user: The current user
    :return: A structure detailing the save result

    """


I can move that signature around, have it with or without "self" and either 
way it doesn't work.
I was under the impression that the signature would override the decorator, 
was I wrong?


Warm regards,
Nicklas Börjesson

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Reply via email to