search

rust-scraper / scraper

HTML parsing and querying with CSS selectors
https://docs.rs/scraper
ISC License
1.89k stars 107 forks source link

More explicit description to Element type and some doc complement #210

Open latot opened 3 weeks ago

latot commented 3 weeks ago

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!

cfvescovo commented 2 weeks ago

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

latot commented 2 weeks ago

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

cfvescovo commented 2 weeks ago

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

teymour-aldridge commented 2 weeks ago

Examples are very welcome (and much needed)!