EbookFoundation
/
free-programming-books-parser
mirror of https://github.com/EbookFoundation/free-programming-books-parser.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: fix jsdocs

pull/11/head
David Ordás 2022-09-18 14:36:10 +02:00
parent af804ee329
commit d9dacf2dd1
No known key found for this signature in database
GPG Key ID: 6FD751229911593E
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
index.js
View File

@ -70,12 +70,12 @@ function getSectionNameFromHeadingContent(children) {
} }
/** /**
* Parses the contents of a heading from remark-parse into a readable format. * Parses the contents of a link from remark-parse into a readable format.
* *
* @param {Array<Object>} children - an array of AST items defined by remark-parse for * @param {Array<Object>} children - an array of AST items defined by remark-parse for
* the content of headings (H1..H7) * the content of a link (A)
* *
* @returns {string} an string with the name of the section related with the input heading * @returns {string} an string with the text of the related input link
*/ */
function getLinkTextFromLinkNodes(children) { function getLinkTextFromLinkNodes(children) {
// visit nodes in depth // visit nodes in depth