aboutcode-org / aboutcode-org/aboutcode-toolkit

Improve documentation for Attribution

未关闭
#507 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Python
星标
100
派生
49
PR 合并指标
30 天内没有已合并 PR

描述

Within the ABCTK documentation, we should make a distinction between the features and functions that operate on ABOUT files and those that do not require ABOUT files - namely Attribution. This means that we should organized the documentation at a high level under either Attribution or ABOUT files. The attrib and transform commands would be under Attribution and the rest under ABOUT files.

We also need a much more detailed explanation of the content of the transform yaml files - this could just be a copy of the help text from the --help--format function. We do not want to required someone to install ABCTK just to understand how the transform can work.

贡献指南

这个仓库没有索引到贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

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