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

List of things that could be documented better #16591

Open
jdm opened this issue Apr 24, 2017 · 3 comments
Open

List of things that could be documented better #16591

jdm opened this issue Apr 24, 2017 · 3 comments

Comments

@jdm
Copy link
Member

@jdm jdm commented Apr 24, 2017

This is intended as an issue for anybody to request more/better documentation for specific parts of Servo that interest them.

@jasonwilliams
Copy link
Contributor

@jasonwilliams jasonwilliams commented Apr 24, 2017

If someone could make something like this, https://www.youtube.com/watch?v=dRo_egw7tBc that would be amazing.
In this video @spicyj does a very good job walking through the code from beginning to end, showing what files and folders do what. Even if you don't use react, its worth watching for inspiration.

I know its a big ask, but would be nice to have @metajack or someone do something similar

@jdm
Copy link
Member Author

@jdm jdm commented Apr 24, 2017

We should document the relationship between Attr, IDL attributes, content attributes, Element::get_attribute, Element::get_string_attribute, and VirtualMethods::parse_plain_attribute.

@metajack
Copy link
Contributor

@metajack metajack commented Apr 24, 2017

I worked a bit on DOM code last week, and immediately ran into the issue that the rooting documentation is out of date. The comments in the source files about how to get from JS to Root were not right.

It would probably be useful to show correspondence from webidl to Rust as well has how to get back and forth between various types.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.