autoattribute for parallel assignment

[Buken Li]

When documenting instance variables, I can do class Foo: def __init__(self): self.spam = 4 """Docstring for instance attribute spam.""" This doesn't work for parallel assignment class Foo: def __init__(self): self.spam, self.bar, self.moo = 4, 5, 6 """Docstring for instance attribute spam.""" Is there any way I can document variables when using parallel assignment? Thanks.

[Takayuki Shimizukawa]

Hi, 

I think there is no way to document for parallel assigned attributes.

Please write each attribute documentation in separated lines.

Technically: sphinx.pycode.AttrDocVisitor.add_docstring function interpret a attribute documentation.

IF block at line 146 invoked only when `self.variable = value` style line placed before/after a doc-comment.

https://bitbucket.org/birkenfeld/sphinx/src/ba4b069e/sphinx/pycode/__init__.py#cl-146

Regards,

--
Takayuki SHIMIZUKAWA
http://about.me/shimizukawa

--
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 sphinx-users...@googlegroups.com.
To post to this group, send email to sphinx...@googlegroups.com.
Visit this group at http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

[Buken Li]

Sometimes parallel assignment is the cleanest way to write. For example

class Foo:
    def __init__(self):
        self.spam, self.bar, self.moo = baz()

Its too bad that sphinx doesn't support this.
btw it is possible to manually write the doc in these situations. See http://stackoverflow.com/a/24046052/1993391

[Takayuki Shimizukawa]

Hi,

2014-06-17 0:31 GMT+09:00 Buken Li <gga...@gmail.com>:
> Sometimes parallel assignment is the cleanest way to write. For example
>
> class Foo:
> def __init__(self):
> self.spam, self.bar, self.moo = baz()
>
> Its too bad that sphinx doesn't support this.

It makes sense.
Please post a feature request to the issue tracker :)

> btw it is possible to manually write the doc in these situations. See http://stackoverflow.com/a/24046052/1993391

Yeah, autodoc creates intermediate reST text internally as the
stackoverflow's comment described.