Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation of extra fields {pak} adds to the DESCRIPTION #598

Open
wurli opened this issue Feb 25, 2024 · 2 comments
Open

Documentation of extra fields {pak} adds to the DESCRIPTION #598

wurli opened this issue Feb 25, 2024 · 2 comments

Comments

@wurli
Copy link

wurli commented Feb 25, 2024

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 😃

@gaborcsardi
Copy link
Member

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

@wurli
Copy link
Author

wurli commented Feb 26, 2024

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants