taoqf / node-html-parser

A very fast HTML parser, generating a simplified DOM, with basic element query support.
MIT License
1.12k stars 112 forks source link

Docs titles are hard to read #216

Closed davestewart closed 2 years ago

davestewart commented 2 years ago

Hi!

Thanks for the great lib. Using it very successfully.

My only comment is that the docs are hard to read on both there and NPM because of the classname prefix.

Could you do something to make it easier to read, perhaps change the format from:

HTMLElement Methods

HTMLElement#trimRight()

Trim element from right (in block) after seeing pattern in a TextNode.

To

HTMLElement Methods

trimRight()

Trim element from right (in block) after seeing pattern in a TextNode.

I think it's clear it's the HTMLElement; IMHO the tradeoff between explicitness and clarity doesn't serve the developer here.

Thanks, Dave

taoqf commented 2 years ago

Thanks for your advice

davestewart commented 2 years ago

Nice! Much more readable, thank you ☺️