scraper icon indicating copy to clipboard operation
scraper copied to clipboard

More explicit description to Element type and some doc complement

Open latot opened this issue 1 year ago • 4 comments

Hi! following from: https://github.com/rust-scraper/scraper/issues/196

Comment: https://github.com/rust-scraper/scraper/issues/196#issuecomment-2368701405

I think would be good in the docs describe better what a Element will be, I suppose a element is a html tag element.

Also, I think would be good add in the main webpage of the docs, a description of the basic elements and their definitions, like Nodes, Elements, Text, etc. And include the deref operator definition for each one, maybe just some examples to know how we move from one type to other.

Thx!

latot avatar Sep 23 '24 18:09 latot

Element is provided by the selectors crate: docs I agree that they should be improved but it's not under our control. We could provide a better description in our docs though

cfvescovo avatar Sep 26 '24 14:09 cfvescovo

I think is enough to just provide better descriptions and some examples for some basic workflows :)

latot avatar Sep 26 '24 14:09 latot

If you have any suggestions about examples/descriptions, feel free to open a PR. I will be glad to review it ASAP

cfvescovo avatar Sep 26 '24 14:09 cfvescovo

Examples are very welcome (and much needed)!

teymour-aldridge avatar Sep 26 '24 14:09 teymour-aldridge