Skip to content
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

Add data guideline: partial_implementation requires a note #7332

Merged
merged 4 commits into from
Nov 13, 2020
Merged

Add data guideline: partial_implementation requires a note #7332

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
674ccad
Add a guideline that requires notes for "partial_implementation"
ddbeck Nov 10, 2020
8f23abe
Update TOC
ddbeck Nov 10, 2020
342196b
Group related partial_implementation guidelines
ddbeck Nov 10, 2020
3c81187
Link to PR
ddbeck Nov 10, 2020
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
9 changes: 9 additions & 0 deletions docs/data-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ This file contains recommendations to help you record data in a consistent and u
- [Secure context required (`secure_context_required`)](#secure-context-required-secure_context_required)
- [Web Workers (`worker_support`)](#web-workers-worker_support)
- [Permissions API permissions (`permissionname_permission`)](#permissions-api-permissions-permissionname_permission)
- [`"partial_implementation"` requires a note](#partial_implementation-requires-a-note)
- [Non-functional defined names imply `partial_implementation`](#non-functional-defined-names-imply-partial_implementation)
- [Release lines and backported features](#release-lines-and-backported-features)
- [Safari for iOS versioning](#safari-for-ios-versioning)
Expand Down Expand Up @@ -148,6 +149,14 @@ For example, the Geolocation permission is named `geolocation_permission` with t

This guideline was proposed in [#6156](https://github.com/mdn/browser-compat-data/pull/6156).

## `"partial_implementation"` requires a note

If you set `"partial_implementation": true`, then write a note describing how the implementation is incomplete.

For historical reasons, some support statements have the flag set to `true` without a note. Avoid this in new data or revised data. We intend to require this in the schema, after the features which do not conform to this guideline have been removed. Read [#4162](https://github.com/mdn/browser-compat-data/issues/4162) for details.

This guideline was proposed in [#7332](https://github.com/mdn/browser-compat-data/pull/7332).

## Non-functional defined names imply `partial_implementation`

If a browser recognizes an API name, but the API doesn’t have any discernable behavior, use `"partial_implementation": true` instead of `"version_added": false`, as if the feature has non-standard support, rather than no support.
Expand Down