pak icon indicating copy to clipboard operation
pak copied to clipboard

Documentation of extra fields {pak} adds to the `DESCRIPTION`

Open wurli opened this issue 1 year ago • 2 comments

From the pak documentation, I've found some discussion of a few fields which are added to the DESCRIPTION files of packages installed using pak. However, as a package developer, I would find it helpful to have a single page to document these and explain how they are used by pak, and how they are intended to be used by other parties.

Many thanks - pak is an amazing package 😃

wurli avatar Feb 25 '24 19:02 wurli

Thanks! They are not intended to be used by other parties currently, hence they are also not documented.

gaborcsardi avatar Feb 25 '24 20:02 gaborcsardi

Fair enough! Perhaps there's then a question about whether this should be more explicitly noted in the documentation. AFAIK, DESCRIPTION files are intended to be read by users (although doubtless this is happens fairly rarely), and documentation definitely does exist for the standard fields. Perhaps simply a list of the fields which pak adds would be helpful, so users can at least get a quick idea of which fields are non-standard?

wurli avatar Feb 26 '24 14:02 wurli