feat: add support for "external" stability #596
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add support for a new class of stability called "imported". This stability class is treated like "stable" for documentation purposes, but always lead to warnings (not errors) for stability comparison purposes.
eladb
reviewed
Jul 12, 2019
There was a problem hiding this comment.
I am struggling with the name... without context it’s impossible to understand why this tag is added. Why not add support for something like “@stability X” as an additional way to specify stability (think ability the current stability tags as sugar for this) and then we can had a stability type of “unknown” or “ignore”
|
|
||
| test.deepEqual(classType.docs!.stability, spec.Stability.Imported); | ||
| test.deepEqual(method!.docs!.stability, spec.Stability.Imported); | ||
| test.done(); |
There was a problem hiding this comment.
Don’t we need a test which verifies that imported can break with only warnings?
There was a problem hiding this comment.
|
We decided on |
|
Discussed face to face and decided on |
eladb
approved these changes
Jul 16, 2019
eladb
changed the title
RomainMuller
force-pushed
the
master
branch
3 times, most recently
from
1315be5
to
8552b7a
Compare
RomainMuller
approved these changes
Jul 16, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add support for a new class of stability called "imported".
This stability class is treated like "stable" for documentation purposes,
but always lead to warnings (not errors) for stability comparison purposes.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.