RichText & Docs: remove or rename undocumented functions and constants #14239

ellatrix · 2019-03-05T11:41:16Z

Description

This change removes all rich-text exceptions in the doc generation script.

I'm removing some functions that were never documented and are only used in a few cases. Elsewhere the properties are just accessed directly. insertLineBreak was added in #13546, but the complexity around it was removed in #13850 and since then it's also no longer useful. It was also never documented.

I'm also prefixing all the remaining exports that are undocumented with __unstable.

How has this been tested?

Screenshots

Types of changes

Checklist:

My code is tested.
My code follows the WordPress code style.
My code follows the accessibility standards.
My code has proper inline documentation.
I've included developer documentation if appropriate.

packages/rich-text/src/get-selection-start.js

packages/editor/src/components/rich-text/patterns.js

aduth · 2019-03-18T20:09:40Z

I don't really have any objections here, though it will need a rebase. Does the fact it missed the 5.3 release (WordPress 5.2) have any implications on your desire to move forward here?

ellatrix · 2019-03-28T09:27:51Z

I don't really have any objections here, though it will need a rebase. Does the fact it missed the 5.3 release (WordPress 5.2) have any implications on your desire to move forward here?

No, I'd still like to move forward with this. The same issue remains.

Fixed

oandregal · 2019-04-01T08:57:59Z

packages/rich-text/src/index.js

 export { getTextContent } from './get-text-content';
 export { isCollapsed } from './is-collapsed';
-export { isEmpty, isEmptyLine } from './is-empty';
+export { isEmpty, isEmptyLine as __unstableIsEmptyLine } from './is-empty';


Renaming the symbol at this point to use the __unstable prefix will work as far as the doc generator is concerned because it uses the export statements to filter out the symbols to be ignored. However, I would lean towards renaming the symbol declaration as well. It may be benefitial as an urge to settle this API every time we work on it. Thoughts?

Yeah, maybe it's good to do that. But the reason it's marked unstable is that it was never meant to be exported. It's only used by the RichText component, which should eventually live in these packages. So it's meant as an internal helper function, temporarily exported because these's one component left that's not been moved to this package yet.

It may be benefitial as an urge to settle this API every time we work on it.

So, regarding this, there's nothing to be settled. We need to move RichText so we can remove the export statements.

oandregal · 2019-04-01T08:58:18Z

bin/update-readmes.js

@@ -35,31 +35,15 @@ const packages = [
 	'wordcount',
 ];

-const getArgsForPackage = ( packageName ) => {


oandregal · 2019-04-01T09:01:47Z

I've tested this a bit based on the changes I saw. This is what I've found:

Hit INTRO in a paragraph splits it into two paragraph blocks but the first one becomes invalid.
Left/Right arrow keys don't work.

ellatrix · 2019-04-01T11:17:59Z

@nosolosw Oops, forgot to change an import statement after the rename. Fixed in 0b1182b. Thanks for testing!

aduth · 2019-04-03T13:26:50Z

(Noting there are some merge conflicts here)

oandregal

Code changes make sense. Tested and couldn't find any breakage.

oandregal · 2019-04-10T09:15:10Z

I did find an issue that I can repro on master, though: #14896

ellatrix · 2019-04-10T09:24:10Z

Thanks @nosolosw!

WordPress#14239) * RichText & Docs: remove or rename undocumented functions and constants * Fix import after renaming

ellatrix requested review from aduth, jorgefilipecosta and youknowriad as code owners March 5, 2019 11:41

ellatrix mentioned this pull request Mar 5, 2019

rich-text: set up autogenerated API docs #14220

Merged

aduth previously requested changes Mar 5, 2019

View reviewed changes

packages/rich-text/src/get-selection-start.js Show resolved Hide resolved

ellatrix force-pushed the remove/undocumented-rich-text-functions branch from 0793065 to cb2708b Compare March 5, 2019 14:01

ellatrix requested a review from aduth March 5, 2019 14:02

aduth reviewed Mar 5, 2019

View reviewed changes

packages/editor/src/components/rich-text/patterns.js Outdated Show resolved Hide resolved

ellatrix force-pushed the remove/undocumented-rich-text-functions branch from cb2708b to 5b2bef0 Compare March 28, 2019 08:36

ellatrix changed the title ~~RichText: remove some undocumented functions~~ RichText & Docs: remove or rename undocumented functions and constants Mar 28, 2019

ellatrix force-pushed the remove/undocumented-rich-text-functions branch from 5b2bef0 to d8dfa86 Compare March 28, 2019 09:18

ellatrix requested review from ajitbohra, gziolo, nerrad and ntwb as code owners March 28, 2019 09:18

ellatrix force-pushed the remove/undocumented-rich-text-functions branch from d8dfa86 to 1276de5 Compare March 28, 2019 09:20

ellatrix requested review from oandregal and aduth March 28, 2019 09:26

ellatrix added [Type] Developer Documentation Documentation for developers [Package] Rich text /packages/rich-text [Tool] Docgen /packages/docgen labels Mar 28, 2019

ellatrix added the [Type] Code Quality Issues or PRs that relate to code quality label Mar 28, 2019

ellatrix added this to the 5.4 (Gutenberg) milestone Mar 28, 2019

ellatrix force-pushed the remove/undocumented-rich-text-functions branch from 1276de5 to e3309c7 Compare March 28, 2019 10:38

noisysocks modified the milestones: 5.4 (Gutenberg), 5.5 (Gutenberg) Apr 1, 2019

oandregal reviewed Apr 1, 2019

View reviewed changes

bin/update-readmes.js

@@ -35,31 +35,15 @@ const packages = [

'wordcount',

];

const getArgsForPackage = ( packageName ) => {

Copy link

Member

oandregal Apr 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

ellatrix force-pushed the remove/undocumented-rich-text-functions branch from 0b1182b to db15896 Compare April 2, 2019 12:27

ellatrix requested review from mkaz, noisysocks, notnownikki, Soean and talldan as code owners April 2, 2019 12:27

ellatrix added 2 commits April 3, 2019 17:47

RichText & Docs: remove or rename undocumented functions and constants

7f7578d

Fix import after renaming

7ca2c60

ellatrix force-pushed the remove/undocumented-rich-text-functions branch from db15896 to 7ca2c60 Compare April 3, 2019 15:48

ellatrix mentioned this pull request Apr 3, 2019

Merge bug fixes into wp/trunk #14796

Merged

oandregal self-requested a review April 10, 2019 08:12

oandregal approved these changes Apr 10, 2019

View reviewed changes

ellatrix merged commit e6e5d85 into master Apr 10, 2019

ellatrix deleted the remove/undocumented-rich-text-functions branch April 10, 2019 09:24

This was referenced Apr 15, 2019

Bump version number to 5.5.0-rc.1 #14981

Merged

Bump/5.5 #15011

Closed

Release/5.5 #15012

Closed

Bump plugin version to 5.5 #15013

Merged

aduth mentioned this pull request Apr 25, 2019

Block Editor: Rename UnstableRichTextInputEvent to convention #15198

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RichText & Docs: remove or rename undocumented functions and constants #14239

RichText & Docs: remove or rename undocumented functions and constants #14239

ellatrix commented Mar 5, 2019 •

edited

Loading

aduth commented Mar 18, 2019

ellatrix commented Mar 28, 2019

oandregal Apr 1, 2019

ellatrix Apr 1, 2019

ellatrix Apr 1, 2019

oandregal Apr 1, 2019

oandregal commented Apr 1, 2019

ellatrix commented Apr 1, 2019

aduth commented Apr 3, 2019

oandregal left a comment

oandregal commented Apr 10, 2019

ellatrix commented Apr 10, 2019

RichText & Docs: remove or rename undocumented functions and constants #14239

RichText & Docs: remove or rename undocumented functions and constants #14239

Conversation

ellatrix commented Mar 5, 2019 • edited Loading

Description

How has this been tested?

Screenshots

Types of changes

Checklist:

aduth commented Mar 18, 2019

ellatrix commented Mar 28, 2019

oandregal Apr 1, 2019

Choose a reason for hiding this comment

ellatrix Apr 1, 2019

Choose a reason for hiding this comment

ellatrix Apr 1, 2019

Choose a reason for hiding this comment

oandregal Apr 1, 2019

Choose a reason for hiding this comment

oandregal commented Apr 1, 2019

ellatrix commented Apr 1, 2019

aduth commented Apr 3, 2019

oandregal left a comment

Choose a reason for hiding this comment

oandregal commented Apr 10, 2019

ellatrix commented Apr 10, 2019

ellatrix commented Mar 5, 2019 •

edited

Loading