Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Add documentation to the Editable element #3346
I've added documentation to the Editable element class. I have stopped midway because it takes an incredible amount of time and I want to focus on other Gutenberg related work. This also highlights why it is so incredibly important that documentation be written by the original code author. I don't have the necessary context to write this stuff.
How Has This Been Tested?
It is only documentation
Screenshots (jpeg or gifs if applicable):
Types of changes
@@ Coverage Diff @@ ## master #3346 +/- ## ========================================== + Coverage 34.54% 36.81% +2.26% ========================================== Files 261 271 +10 Lines 6710 6647 -63 Branches 1225 1202 -23 ========================================== + Hits 2318 2447 +129 + Misses 3704 3547 -157 + Partials 688 653 -35
This also highlights what I raised in the core-js meeting. It doesn't make sense to me to add documentation to React component methods like those. These are private functions and change constantly. The time spent to document them is a wasted time because we do not need this documentation to understand the code (for most of them). I propose to be selective and document only the "tricky" parts.