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

Document CharacterData #2396

Closed
Elchi3 opened this issue Feb 16, 2021 · 5 comments
Closed

Document CharacterData #2396

Elchi3 opened this issue Feb 16, 2021 · 5 comments
Labels
Content:WebAPI Web API docs document not written Missing document page

Comments

@Elchi3
Copy link
Member

Elchi3 commented Feb 16, 2021

https://developer.mozilla.org/en-US/docs/Web/API/CharacterData is incomplete. None of the sub pages exist but they should. CharacterData is a core DOM API that is well supported and that should have proper docs.

This came up in #2394 where I removed the weird NonDocumentTypeChildNode mixin, so don't worry about that anymore.

CharacterData is the parent interface for Text, ProcessingInstruction, and Comment nodes, so when creating the pages and example code, you probably want to show how to use CharacterData methods like appendData() with something concrete like https://developer.mozilla.org/en-US/docs/Web/API/Text nodes.

@Ryuno-Ki
Copy link
Collaborator

Is there a list of all pages that are missing?

@Ryuno-Ki Ryuno-Ki added the document not written Missing document page label Feb 16, 2021
@rachelandrew
Copy link
Collaborator

@Ryuno-Ki yup, just look at the page, the ones highlighted in red are not written. Usually with these interface pages, whoever documented the interface will add all of the links to the missing property pages.

BCD will also expose this to you if the BCD has been completed for everything in the API, or ideally take a look at the spec to check. There are a lot of interfaces that are like this.

@Elchi3
Copy link
Member Author

Elchi3 commented Feb 17, 2021

Yep, what Rachel says. BCD is already complete for this one.

@Ryuno-Ki
Copy link
Collaborator

Oh, okay. I thought we would have a meta-issue for tracking them.

@Rumyra Rumyra added the Content:WebAPI Web API docs label Jun 8, 2021
@github-actions github-actions bot added the idle label Dec 8, 2021
@Elchi3
Copy link
Member Author

Elchi3 commented Mar 11, 2022

This got done 🎉

@Elchi3 Elchi3 closed this as completed Mar 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs document not written Missing document page
Projects
None yet
Development

No branches or pull requests

4 participants