docs: document ElementNode methods in DocC - #85
Conversation
Add API comments on ElementNode and a topic page that groups children, selection, indent, and merge heuristics, matching the existing Node.md catalog style. Fixes facebook#22
|
Hi @mangeshraut712! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
1 participant
Summary
Fixes #22
Documents every ElementNode API with DocC comments and adds
Documentation.docc/ElementNode.md, grouping methods the same wayNode.mddoes (children, insert/remove, selection, indent/direction, merge heuristics, text output).AI usage: an assistant drafted the comments from the Swift implementations and the Lexical JS ElementNode concepts; I aligned topic symbols with the actual method names.
Test Plan
ElementNode.mdtopic links to declarations inElementNode.swift.