Opened 16 years ago

Closed 14 years ago

#2084 enhancement closed wontfix (wontfix)

Review public API of web2

Reported by: Glyph Owned by:
Priority: high Milestone: Web2-Gold-Master
Component: web2 Keywords:
Cc: Jean-Paul Calderone Branch:
Author:

Description

The goal of this review is to make sure that the API is something we are all willing to declare stable, and also to figure out (and document) which parts are declared stable.

Since some of the web2 code is pre-UQDS, we should not turn this into a comprehensive code review. The review should take place on the pydoctor-generated API documentation.

The output of this review should be:

  • a list of suggested changes to the APIs as presented
  • a list of currently public classes, functions, and modules which should be made private (e.g. prefixed with "_")
  • recommendations for any bad or dead code which should be removed entirely
  • a list of work-in-progress APIs to mark as "unstable"

This bug should be closed only once all of these recommendations have been addressed - please create additional tickets for required development work and link them from this ticket.

Change History (2)

comment:1 Changed 14 years ago by Jean-Paul Calderone

Cc: Jean-Paul Calderone added
Resolution: wontfix
Status: newclosed

web2 will remain as it is. Features will be ported to twisted.web individually (or in small groups, where that makes sense). As each feature is ported, the API can be reviewed in the same manner as is usual for code reviews of new features. So, nothing to do here.

comment:2 Changed 11 years ago by <automation>

Owner: jknight deleted
Note: See TracTickets for help on using tickets.