aboutcode-org / aboutcode-org/scancode-toolkit

Add extra documentation to each package class

未关闭
#3,799 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
documentation package-formats Priority: medium
主要语言
Python
星标
2.6k
派生
791
平均合并
1 天 12 小时
30 天内合并 PR
5

描述

We should add extra documentation to each package class, possibly structured as attributes in order to better capture the breadth and depth of the data we collect to generate a summary table for all the things we have.
This could include new things:
- logos
- if a data file is a lock file or not
- extra support and capabilities in other tools like binary analysis, inspectors such as dependency-inspector
- core command(s) to generate lock file or install packages in dependency-inspector
- pointer to the main package management tool repo
- typical files extensions included (.py in pypi, and so on)
- extra documentation
- etc.

Beyond mere documentation, some of these attributes may have a practical use (like the command for dependency-inspector)

We should also track the relationship to other data files and manifests (important so we cant start treating these as pairs or groups). This could be an attribute, or a new class of its own that groups many datafile handler classes.

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。