Docstrings for classes get "doubled"

[Hans Terlouw]

Docstrings for classes get "doubled". For example, the docstring in the following Cython code:

class dummy(object):
   "Dummy class documentation"
   pass

will appear "doubled" in the generated C code:

static char __pyx_k_2[] = "Dummy class documentation\nDummy class documentation";

(Docstrings for functions and methods are not affected.)

[scoder (scoder)]

The code in Nodes.py goes like this:

  class PyClassDefNode(StatNode, BlockNode):
    def __init__(self, pos, name, bases, doc, body):
        # ...
        self.doc = doc
        # ...
        if self.doc and Options.docstrings:
            if Options.embed_pos_in_docstring:
                doc = 'File: %s (starting at line %s)'%relative_position(self.pos)
            doc = doc + '\\n' + self.doc
            doc_node = ExprNodes.StringNode(pos, value = doc)
        else:
            doc_node = None

I have no idea what the

    doc = doc + '\\n' + self.doc

bit is supposed to mean. It looks like it's there for a purpose...

[scoder (scoder)]

Ah, maybe it just lacks indentation? This makes more sense to me:

        if self.doc and Options.docstrings:
            if Options.embed_pos_in_docstring:
                doc = 'File: %s (starting at line %s)'%relative_position(self.pos)
                doc = doc + '\\n' + self.doc

[Hans Terlouw (j-p-terlouw)]

Thanks a lot!