Replace uses of @ivar in interfaces with z.i.Attribute

[jknight]

yep, that.

[Glyph]

This should probably be done eventually, but I can't imagine that it's on my list of top 1000 things to do for Twisted :).

Anyone else should feel free to steal.

[Thijs Triemstra]

Can someone give me an example of when and where to replace what so I can work on this?

[therve]

The attached patch should give you an example of what to do. Feel free to get back to me if it's not clear.

[Thijs Triemstra]

Replying to therve:

The attached patch should give you an example of what to do. Feel free to get back to me if it's not clear.

Thanks therve, that's clear now.

[Thijs Triemstra]

(In [24700]) Branching to 'ivar-interfaces-1852'

[Jean-Paul Calderone]

Convention thus far has been to include the @type information in the Attribute docstring. It seems pydoctor ignores the type information for an Attribute, anyway.

twisted.web2.iweb.IChanRequest.getHostInfo isn't valid for pydoctor. epytext should allow C{} to span multiple lines, but for some reason this generates an error from pydoctor.

IGroup.join doesn't need pass anymore. Some methods in twisted/web2/iweb.py also have redundant pass statements.

Whitespace change before the id method in twisted/trial/itrial.py should be reverted

[Thijs Triemstra]

Replying to exarkun:

Convention thus far has been to include the @type information in the Attribute docstring. It seems pydoctor ignores the type information for an Attribute, anyway.

Not sure what this means, left it as it is, let me know if you want it included or..

twisted.web2.iweb.IChanRequest.getHostInfo isn't valid for pydoctor. epytext should allow C{} to span multiple lines, but for some reason this generates an error from pydoctor.

Removed the C{} markup again.

IGroup.join doesn't need pass anymore.

removed that pass in twisted/words/im/interfaces.py

Some methods in twisted/web2/iweb.py also have redundant pass statements.

Removed the redundant statements, except for the ones in IOldRequest since they don't have any docstrings.

Whitespace change before the id method in twisted/trial/itrial.py should be reverted

Fixed, see r24836

[Thijs Triemstra]

Replying to thijs:

Removed the redundant statements, except for the ones in IOldRequest since they don't have any docstrings.

See #3416, where exarkun will probably add those missing docstrings.

[Jean-Paul Calderone]

Replying to thijs:

Replying to exarkun:

Convention thus far has been to include the @type information in the Attribute docstring. It seems pydoctor ignores the type information for an Attribute, anyway.

Not sure what this means, left it as it is, let me know if you want it included or..

It means don't do this:

class IFoo(Interface):
    """
    blah blah 

    @type bar: C{int}
    """
    bar = Attribute("number of bars")

Instead, do this:

class IFoo(Interface):
    """
    blah blah
    """
    bar = Attribute("An C{int} giving the number of bars")

[Jean-Paul Calderone]

Also, there's a conflict with trunk now, please merge forward.

[Thijs Triemstra]

(In [24867]) Branching to 'ivar-interfaces-1852-2'

[Thijs Triemstra]

Included the type information in the Attributes for [source:trunk/twisted/words/im/interfaces.py], see r24869

[Jean-Paul Calderone]

• twisted/words/im/interfaces.py
  • The I{} which was in the IGroup docstring and is now the docstring for that interface's account attribute doesn't really make sense. It should be I{account} or L{account<IAccount>}. This is repeated in the docstring for IGroup.__init__.
  • The docstring for IGroup.sendGroupMessage used to have two levels of indentation for style and emote (emote is hierarchically inferior to style); now it has one, this should go back to how it was.
• twisted/internet/interfaces.py
  • IReactorCore has L{Reactor} in its docstring now, but there is nothing named Reactor that can be linked to.
• twisted/spread/interfaces.py - changes here don't seem significant

[Thijs Triemstra]

Made the changes in r24881

[Jean-Paul Calderone]

Looks fine, please merge.

[Thijs Triemstra]

(In [24916]) Merge ivar-interfaces-1852-2: Replace uses of @ivar in interfaces with z.i.Attribute

Author: thijs Reviewer: therve, exarkun Fixes: #1852