Skip to content

Commit

Permalink
Docs: Add unstable API convention to coding guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
aduth committed Nov 19, 2018
1 parent 6f60b49 commit accb891
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/reference/coding-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,13 @@ Exposed APIs that are still being tested, discussed and are subject to change sh
Example:

```js
export {
internalApi as __experimentalExposedApi
} from './internalApi.js';
export { __experimentalDoAction } from './api';
```

If an API must be exposed but is clearly not intended to be supported into the future, you may also use `__unstable` as a prefix to differentiate it from an experimental API. Unstable APIs should serve an immediate and temporary purpose. They should _never_ be used by plugin developers as they can be removed at any point without notice, and thus should be omitted from public-facing documentation. The inline code documentation should clearly caution their use.

```js
export { __unstableDoAction } from './api';
```

### Variable Naming
Expand Down

0 comments on commit accb891

Please sign in to comment.