The documentation descriptions are useless

Bug #81830 reported by Dean Sas
2
Affects Status Importance Assigned to Milestone
egenix-mx-base (Ubuntu)
Confirmed
Wishlist
Unassigned

Bug Description

The document description just repeats the name of the document and provides no extra information.

For example:
eGenix mxTextTools Manual - Manual for eGenix mxTextTools.

A better description would be something like "This document provides API documentation for using efficient text manipulation tools in python"

Revision history for this message
Dean Sas (dsas) wrote :

I've attached a screendump showing how this displays in yelp.

Revision history for this message
Matt Thompson (mattthompson) wrote :

Very true.

The words chocolate tea-pot come to mind.

Changed in egenix-mx-base:
status: Unconfirmed → Confirmed
Revision history for this message
Matthias Klose (doko) wrote :

do you want to send a patch?

Changed in egenix-mx-base:
importance: Undecided → Wishlist
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.