Skip to content

Commit f1d96b3

Browse files
authored
Merge pull request #5313 from Yoast/add/code-style-experimental-documentation
Updated coding-guideline documentation to include experimental APIs
2 parents b501f73 + c8b3d1a commit f1d96b3

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/coding-guidelines.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,18 @@ Example:
8686
import VisualEditor from '../visual-editor';
8787
```
8888

89+
### Experimental APIs
90+
91+
Exposed APIs that are still being tested, discussed and are subject to change should be prefixed with `__experimental`, until they are finalized. This is meant to discourage developers from relying on the API, because it might be removed or changed in the (near) future.
92+
93+
Example:
94+
95+
```js
96+
export {
97+
internalApi as __experimentalExposedApi
98+
} from './internalApi.js';
99+
```
100+
89101
## PHP
90102

91103
We use

0 commit comments

Comments
 (0)