carpentries-incubator / carpentries-incubator/lesson-R-packaging

Talk about manual generation

Open
#57 0 comments 0 reactions 0 assignees View on GitHub
ch-documentation enhancement low-priority
Dominant language
No language data
Stars
5
Forks
9
PR merge metrics
No merged PRs in 30d

Description

## Problem

We teach how to generate docstrings. We show how to access them on the help panel. But we don't show how to generate a CRAN-style manual.

## Solution

At least explain that this can be done, and show it locally.

Why show instead of asking the students to do it? Because it requires `pdflatex`, a requirement that is usually not covered.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.