aboutcode-org / aboutcode-org/scancode-toolkit

Do not include duplicated name in description of a Maven package

Open
#3,362 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
2.6k
Forks
791
Avg merge
1d 12h
Merged PRs (30d)
5

Description

When I scan this POM https://repo1.maven.org/maven2/javax/activation/activation/1.1/activation-1.1.pom

I get this description:
> JavaBeans Activation Framework (JAF)
> JavaBeans Activation Framework (JAF) is a standard extension to the Java platform that lets you take advantage of standard services to: determine the type of an arbitrary piece of data; encapsulate access to it; discover the operations available on it; and instantiate the appropriate bean to perform the operation(s).

where we combined the name and description of the POM.
```
JavaBeans Activation Framework (JAF)

JavaBeans Activation Framework (JAF) is a standard extension to the Java platform that lets you take advantage of standard services to: determine the type of an arbitrary piece of data; encapsulate access to it; discover the operations available on it; and instantiate the appropriate bean to perform the operation(s).

```
... we should not include the "name" if it exists at the start of the description.
We have the code for it in this: https://github.com/nexB/scancode-toolkit/blob/b6d0162d1c1b0c1dc71317cfbc7b8c64847f8159/src/packagedcode/utils.py#L115

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.