Opened 8 months ago

Closed 6 months ago

#6907 enhancement closed fixed (fixed)

Deprecate Lore

Reported by: khorn Owned by: hawkowl
Priority: normal Milestone: Twisted-14.0.0
Component: lore Keywords:
Cc: Branch: branches/deprecate-lore-6907
(diff, github, buildbot, log)
Author: hawkowl Launchpad Bug:

Description

As Twisted has switched to using Sphinx for generating documentation, Lore is no longer needed, and should be deprecated.

Once Lore has been deprecated, and is no longer needed, another ticket should be created to remove it.

See: http://twistedmatrix.com/trac/wiki/CompatibilityPolicy#Modules

Change History (5)

comment:1 Changed 6 months ago by hawkowl

  • Author set to hawkowl
  • Branch set to branches/deprecate-lore-6907

(In [41772]) Branching to deprecate-lore-6907.

comment:2 Changed 6 months ago by hawkowl

  • Keywords review added

I've taken a stab at deprecating it.

comment:3 Changed 6 months ago by adiroiban

Looks good to me. Thanks! Buildbot test are not available.

comment:4 Changed 6 months ago by exarkun

  • Keywords review removed
  • Owner set to hawkowl

Thanks.

  1. I'm not sure I see the benefit of deleting the TODO comment in twisted/lore/__init__.py as part of this change.
  2. I've tried to figure out why this module uses unittest.TestCase but I can't. I don't think the module should use *both* unittest.TestCase *and* twisted.trial.unittest.TestCase. One thing I do see is that the existing twisted imports in this test module are a subset of the imports in twisted/__init__.py. I don't see how that could actually matter in this case though. I suspect since all the tests pass even with the new twisted.trial.unittest import it's safe to switch this code entirely over to trial. Also, please use the from twisted.trial.unittest import TestCase style of import.
  3. You might like namedAny("twisted.lore") or maybe just __import__("twisted.lore") to avoid needing to hack around pyflakes warnings.
  4. American English spelling, sorry! favor instead of favour.
  5. There's no standard (maybe there should be) for this but consider:
    exarkun@top:~/Projects/Twisted/trunk$ grep "was deprecated" twisted/ -r --include '*.py' | wc -l
    76
    exarkun@top:~/Projects/Twisted/trunk$ grep "is deprecated" twisted/ -r --include '*.py' | wc -l
    120
    

Thanks again. Please merge after addressing those points.

comment:5 Changed 6 months ago by hawkowl

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

(In [41790]) Merge deprecate-lore-6907: Deprecate Twisted Lore

Author: hawkowl
Reviewer: exarkun
Fixes: #6907

This deprecates Twisted Lore, in favor of using Sphinx, from Twisted 14.0.

Note: See TracTickets for help on using tickets.