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.

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

chore: section clarity, harden API, providers #149

Merged
merged 2 commits into from
Oct 17, 2022
Merged

Conversation

toddbaert
Copy link
Member

@toddbaert toddbaert commented Oct 13, 2022

Marking Evaluation API and Providers hardening and a few non-functional changes here that improve structure.

specifically:

  • explicitly mark and number all sections
  • section headings have consistent numbering (provider section numbering was different than the other docs)
  • removed "draft" language

An alternative to marking all of provider and evaluation API as hardening would be just marking all existing sections therein as hardening, which might be better since we'd have to do that anyway if we added a new experimental section.

see: #146 for more on release goals.

Signed-off-by: Todd Baert <toddbaert@gmail.com>
Copy link
Member

@beeme1mr beeme1mr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changing the spec version numbers may require numerous changes to tests in various SDKs. That doesn't necessary mean we can make the change but we should be aware of the impact.

specification.json Outdated Show resolved Hide resolved
specification/sections/01-flag-evaluation.md Show resolved Hide resolved
Signed-off-by: Todd Baert <toddbaert@gmail.com>
@toddbaert
Copy link
Member Author

toddbaert commented Oct 13, 2022

Changing the spec version numbers may require numerous changes to tests in various SDKs. That doesn't necessary mean we can make the change but we should be aware of the impact.

100%. I know this changes some tests, but this change should actually reduce such thrashing in the future and makes things more consistent. Provider was the only section where the requirements didn't have 3 decimal places.

@toddbaert
Copy link
Member Author

toddbaert commented Oct 13, 2022

An alternative to marking all of provider and evaluation API as hardening would be just marking all existing sections therein as hardening, which might be better since we'd have to do that anyway if we added a new experimental section.

@toddbaert
Copy link
Member Author

toddbaert commented Oct 17, 2022

@justinabrahms do you have any objections to this? (I volunteer to absorb the test-renumbering in the java-sdk)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants