Skip to content

Updated coding-guideline documentation to include experimental APIs #5313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
atimmer merged 3 commits into from
Mar 2, 2018
Merged

Updated coding-guideline documentation to include experimental APIs #5313

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
98b3711
Updated coding-guideline documentation to include experimental APIs
Feb 28, 2018
3959fbe
Clarified example
Feb 28, 2018
c8b3d1a
Changed experimental features documentation back to __experimental
Mar 1, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/coding-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,18 @@ Example:
import VisualEditor from '../visual-editor';
```

### Experimental APIs

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.

Example:

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

## PHP

We use
Expand Down