srid/cargo-doc-live

Add option to configure `cargo doc` arguments

Open

#2 opened on Aug 14, 2023

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Nix (4 forks)github user discovery
good first issue

Repository metrics

Stars
 (12 stars)
PR merge metrics
 (PR metrics pending)

Description

https://github.com/srid/cargo-doc-live/blob/fb1d4439d847f01ce4ccf1905d1630c1994569b0/flake-module.nix#L57

Instead of hardcoding --document-private-items --all-features, allow the user to specify them as module options. Eg.:

{
  cargo-doc-live = {
    cargo-doc-args = "--document-private-items --all-features";
  };
}

Contributor guide

Research direction
Add a new module option for cargo doc args and modify the flake module.nix to use that option instead of hardcoded values.
Tech stack
None
Domain
build system
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Nix
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70