parallax/jsPDF

General Documentation Improvements

Open

#2,931 建立於 2020年9月24日

在 GitHub 查看
 (3 留言) (0 反應) (1 負責人)JavaScript (4,596 fork)batch import
difficulty:mediumhacktoberfestpersistent

倉庫指標

Star
 (28,280 star)
PR 合併指標
 (30 天內沒有已合併 PR)

描述

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 ;)

貢獻者指南