Opened 2 years ago

Closed 2 years ago

#5555 enhancement closed fixed (fixed)

Fix epytext markup issues in twisted.words.xish

Reported by: ClearliteX Owned by: ralphm
Priority: normal Milestone:
Component: words Keywords:
Cc: ralphm, jesstess Branch: branches/xish-epytext-5555
(diff, github, buildbot, log)
Author: ralphm Launchpad Bug:

Description

We have a ton of invalid epytext that produces warnings like shown in http://pastebin.com/Hd7F0Z0G when we generate the docs.

Change History (10)

comment:1 Changed 2 years ago by DefaultCC Plugin

  • Cc ralphm added

comment:2 Changed 2 years ago by jesstess

  • Cc jesstess added

comment:3 Changed 2 years ago by ralphm

  • Author set to ralphm
  • Branch set to branches/xish-epytext-5555

(In [33867]) Branching to 'xish-epytext-5555'

comment:4 follow-up: Changed 2 years ago by ralphm

  • Owner changed from ClearliteX to ralphm
  • Status changed from new to assigned

Apologies for taking over this ticket. I wasn't aware that it was meant as a way to give our new contributors some easy tickets.

I removed the references to build-in types like str, unicode, etc., and to external modules.

I left the other warnings for what they are. Apparently, there are quite some issues with the object resolution within Pydoctor itself:

  • Links to (local and external) module attributes are not resolved.
  • In some cases, two modules documenting things that are in the other module, don't get resolved.
  • Local class attributes sometimes don't resolve (like logTraffic in StreamManager).

comment:5 Changed 2 years ago by ralphm

  • Keywords review added
  • Owner ralphm deleted
  • Status changed from assigned to new

I think this should be ready now. Please review.

comment:6 Changed 2 years ago by ralphm

References to related Pydoctor issues: lp:685376 and lp:957014.

comment:7 Changed 2 years ago by ralphm

comment:8 in reply to: ↑ 4 ; follow-up: Changed 2 years ago by thijs

  • Keywords review removed
  • Owner set to ralphm

Replying to ralphm:

Apologies for taking over this ticket. I wasn't aware that it was meant as a way to give our new contributors some easy tickets.

I removed the references to build-in types like str, unicode, etc., and to external modules.

I left the other warnings for what they are. Apparently, there are quite some issues with the object resolution within Pydoctor itself:

  • Links to (local and external) module attributes are not resolved.
  • In some cases, two modules documenting things that are in the other module, don't get resolved.
  • Local class attributes sometimes don't resolve (like logTraffic in StreamManager).

Thanks for fixing those. Could you also fix the other coding standard stuff like putting docstrings on 3 lines (without the current prefixing whitespace):

"""
Generic Streaming XML protocol handler.

The news file can be an empty .misc file, I doubt users will care we fixed an api doc issue (cause there are many).

comment:9 in reply to: ↑ 8 Changed 2 years ago by ralphm

  • Status changed from new to assigned

Replying to thijs:

.. Could you also fix the other coding standard stuff ..

It is better to do these changes as part of another ticket, as exarkun rightly mentioned in #twisted.

The news file can be an empty .misc file, I doubt users will care we fixed an api doc issue (cause there are many).

Fixed.

comment:10 Changed 2 years ago by ralphm

  • Resolution set to fixed
  • Status changed from assigned to closed

(In [33882]) Merge xish-epytext-5555: Fix epytext warnings in xish and jabber modules.

Author: ralphm
Reviewer: thijs
Fixes: #5555

Note: See TracTickets for help on using tickets.