Code review comment for lp:~bryce/launchpad/api-docs-fixes-bug

Revision history for this message
Eleanor Berger (intellectronica) wrote :

Bryce, all-in-all very nice improvements. There are a few potential problems though, resulting from the way interfaces are used in the UI. In Zope (and Launchpad), the same interfaces that are used to define objects can be used for publishing these objects. Many Launchpad forms, for example, use the Description attribute of fields to render the descriptive text next the field (the same goes for Title). The advantage of this approach is that you don't need to describe the same field twice. The disadvantage, is that the title and description you use must be appropriate both for use in the model and for use in the UI. Some of the titles and descriptions you've added might not be appropriate for the UI (the description for tags, for example, that appears on a bug's +edit page). For the same reason, some of the changes you've made are likely to require changes to pagetests, which I think you haven't adjusted yet in this branch. I think that the changes are good in most cases, but let's go once over the visible changes and make sure they work fine, and perhaps also submit this for UI-review.

b.t.w If you find places where you think the description should be different, all hope is not lost - it is still possible to customize the appearance of fields in the UI by changing them in the relevant classes in the the browser package.

review: Needs Information (code)

« Back to merge proposal