parallax/jsPDF

General Documentation Improvements

Open

#2,931 opened on Sep 24, 2020

View on GitHub
 (3 comments) (0 reactions) (1 assignee)JavaScript (4,596 forks)batch import
difficulty:mediumhacktoberfestpersistent

Repository metrics

Stars
 (28,280 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

The documentation of jsPDF is not very good. Many methods, classes, and parameters are badly documented or not at all.

  • Move all JSDoc comments to the typings file. This will improve the quality of the typings significantly, because IDEs can then display documentation inline. Change the jsdoc task so it uses the typings file instead of the source files (package.json script)
  • Review, fix, and update all documentation comments. Verify the behavior with the code. If there are questions, ask me ;)

Contributor guide

Research direction
Tech stack
Domain
Issue type
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Prerequisites
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.