Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
latot opened this issue Sep 23, 2024 · 4 comments
Open

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

latot opened this issue Sep 23, 2024 · 4 comments
Labels
C-enhancement Category: enhancement

Comments

@latot
Copy link

latot commented Sep 23, 2024

Hi! following from: #196

Comment: #196 (comment)

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
Copy link
Member

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
Copy link
Author

latot commented Sep 26, 2024

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

@cfvescovo
Copy link
Member

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

@teymour-aldridge
Copy link
Collaborator

Examples are very welcome (and much needed)!

@LoZack19 LoZack19 added the C-enhancement Category: enhancement label Oct 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: enhancement
Projects
None yet
Development

No branches or pull requests

4 participants