[Bug 1890562] [NEW] Improve package descriprion

[Iain Lane]

Public bug reported:

Lintian says

E: python3-intervals: description-synopsis-is-duplicated
N: 
N:    The first line of the extended Description: should not repeat the
N:    synopsis exactly. This indicates that either the synopsis is badly
N:    formed or that the extended description has been wrongly copied and
N:    pasted.
N:    
N:    Refer to Debian Policy Manual section 3.4.2 (The extended description)
N:    for details.
N:    
N:    Severity: error
N:    
N:    Check: fields/description
N: 
I: python3-intervals: description-synopsis-might-not-be-phrased-properly "Python tools for handling intervals (ranges of comparable objects)."
N: 
N:    The package synopsis (also known as the "short" description, ie. the
N:    first line in the package's "Description:" field) either ends with a
N:    full stop "." character or starts another sentence.
N:    
N:    This is not necessary as the synopsis does not need to be a full
N:    sentence. It is recommended that a single descriptive phrase is used
N:    instead.
N:    
N:    Note also that the synopsis is not part of the rest of the "long"
N:    Description: field.
N:    
N:    Refer to Debian Developer's Reference section 6.2.2 (The package
N:    synopsis, or short description) for details.
N:    
N:    Severity: info
N:    
N:    Check: fields/description
N: 
I: python3-intervals: extended-description-is-probably-too-short
N: 
N:    The extended description (the lines after the first line of the
N:    "Description:" field) is only one or two lines long. The extended
N:    description should provide a user with enough information to decide
N:    whether they want to install this package, what it contains, and how it
N:    compares to similar packages. One or two lines is normally not enough to
N:    do this.
N:    
N:    Refer to Debian Developer's Reference section 6.2.1 (General guidelines
N:    for package descriptions) and Debian Developer's Reference section 6.2.3
N:    (The long description) for details.
N:    
N:    Severity: info
N:    
N:    Check: fields/description
N:

and it's hard to argue with that. :-)

The current description is

" Description: Python tools for handling intervals (ranges of comparable objects).
  Python tools for handling intervals (ranges of comparable objects).
  .
  This package contains the Python 3 module."

please could you improve it for the next upload?

https://www.debian.org/doc/debian-policy/ch-binary.html#s-descriptions

** Affects: intervals (Ubuntu)
     Importance: Undecided
         Status: New

-- 
You received this bug notification because you are a member of Ubuntu
OpenStack, which is subscribed to intervals in Ubuntu.
https://bugs.launchpad.net/bugs/1890562

Title:
  Improve package descriprion

Status in intervals package in Ubuntu:
  New

Bug description:
  Lintian says

  E: python3-intervals: description-synopsis-is-duplicated
  N: 
  N:    The first line of the extended Description: should not repeat the
  N:    synopsis exactly. This indicates that either the synopsis is badly
  N:    formed or that the extended description has been wrongly copied and
  N:    pasted.
  N:    
  N:    Refer to Debian Policy Manual section 3.4.2 (The extended description)
  N:    for details.
  N:    
  N:    Severity: error
  N:    
  N:    Check: fields/description
  N: 
  I: python3-intervals: description-synopsis-might-not-be-phrased-properly "Python tools for handling intervals (ranges of comparable objects)."
  N: 
  N:    The package synopsis (also known as the "short" description, ie. the
  N:    first line in the package's "Description:" field) either ends with a
  N:    full stop "." character or starts another sentence.
  N:    
  N:    This is not necessary as the synopsis does not need to be a full
  N:    sentence. It is recommended that a single descriptive phrase is used
  N:    instead.
  N:    
  N:    Note also that the synopsis is not part of the rest of the "long"
  N:    Description: field.
  N:    
  N:    Refer to Debian Developer's Reference section 6.2.2 (The package
  N:    synopsis, or short description) for details.
  N:    
  N:    Severity: info
  N:    
  N:    Check: fields/description
  N: 
  I: python3-intervals: extended-description-is-probably-too-short
  N: 
  N:    The extended description (the lines after the first line of the
  N:    "Description:" field) is only one or two lines long. The extended
  N:    description should provide a user with enough information to decide
  N:    whether they want to install this package, what it contains, and how it
  N:    compares to similar packages. One or two lines is normally not enough to
  N:    do this.
  N:    
  N:    Refer to Debian Developer's Reference section 6.2.1 (General guidelines
  N:    for package descriptions) and Debian Developer's Reference section 6.2.3
  N:    (The long description) for details.
  N:    
  N:    Severity: info
  N:    
  N:    Check: fields/description
  N:

  and it's hard to argue with that. :-)

  The current description is

  " Description: Python tools for handling intervals (ranges of comparable objects).
    Python tools for handling intervals (ranges of comparable objects).
    .
    This package contains the Python 3 module."

  please could you improve it for the next upload?

  https://www.debian.org/doc/debian-policy/ch-binary.html#s-descriptions

To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu/+source/intervals/+bug/1890562/+subscriptions