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

Open
#598 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
r
Domain
documentation

Research direction

Start with the linked pak documentation page and review the extra fields it describes for package DESCRIPTION files. Create a single documentation page explaining each field, how pak uses it, and how other parties are intended to use it; done means the fields and their usage are documented together.

Written by the indexing model from the issue text.

Description

documentation

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 😃

Dominant language
C
Stars
821
Forks
88
Avg merge
17m
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from r-lib/pak

All issues in r-lib/pak

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.