Add more documentation #329
Conversation
markup5ever/build.rs
Outdated
| let local_names = Path::new(&env::var("CARGO_MANIFEST_DIR").unwrap()).join("local_names.txt"); | ||
| let mut local_names_atom = string_cache_codegen::AtomType::new("LocalName", "local_name!"); | ||
| for line in BufReader::new(File::open(&local_names).unwrap()).lines() { | ||
| let local_name = line.unwrap(); | ||
| local_names_atom.atom(&local_name); | ||
| local_names_atom.atom(&local_name.to_ascii_lowercase()); | ||
| } | ||
| local_names_atom.write_to(&mut generated).unwrap(); | ||
| local_names_atom | ||
| .with_macro_doc("Takes a local name as a string and returns its key in the a string cache.") |
markup5ever/build.rs
Outdated
| .atoms(NAMESPACES.iter().map(|&(_prefix, url)| url)) | ||
| .write_to(&mut generated) | ||
| .unwrap(); | ||
|
|
||
| writeln!(generated, "#[macro_export] macro_rules! ns {{").unwrap(); | ||
| // T |
markup5ever/interface/mod.rs
Outdated
| @@ -119,6 +144,7 @@ impl QualName { | |||
| } | |||
| } | |||
|
|
|||
| /// Take a reference as an `ExpandedName`, dropping the unresolved prefix. | |||
There was a problem hiding this comment.
It's not clear what "Take a reference" means in this case.
There was a problem hiding this comment.
I've changed this to "Take a reference of self". Do you think this is clear enough, or would you rather something else?
There was a problem hiding this comment.
I think Return this qualified name as an ExpandedName without the unresolved prefix. is more clear.
markup5ever/rcdom.rs
Outdated
| //! See the [document object model article on wikipedia][dom wiki] for more information. | ||
| //! | ||
| //! This implementation stores the information associated with each node once, and then hands out | ||
| //! refs to children. The nodes themselves are reference-counted to avoid copy - you can create a |
|
This is blocked on a new release of string-cache-codegen and dependency bumps. |
|
☔ The latest upstream changes (presumably #332) made this pull request unmergeable. Please resolve the merge conflicts. |
|
@derekdreery Great work, but it seems some upstream changes, kinda broke it. |
|
Yeah I will update
…On 12 Dec 2017 14:38, "Ygg01" ***@***.***> wrote:
@derekdreery <https://github.com/derekdreery> Great work, but it seems
some upstream changes, kinda broke it.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#329 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/ABU-XmW1YvpPoCxN6l6Gqmw-PUUKf0S-ks5s_o_0gaJpZM4Qnsu9>
.
|
|
I'm trying to tidy up old pull requests. I've rebased off latest master (as of 2018-07-25). I think this is ready for review again. |
|
@bors-servo r+ |
|
📌 Commit 0db8e21 has been approved by |
Add more documentation I recently submitted a PR to add documentation. This PR adds some more. Note it won't merge as-is because it relies on PR [#199 in servo/string-cache]. [#199 in servo/string-cache]: servo/string-cache#199
|
☀️ Test successful - status-travis |
I recently submitted a PR to add documentation. This PR adds some more.
Note it won't merge as-is because it relies on PR #199 in servo/string-cache.