Skip to content

chore: section clarity, harden API, providers#149

Merged
toddbaert merged 2 commits into
mainfrom
sections-and-hardening
Oct 17, 2022
Merged

chore: section clarity, harden API, providers#149
toddbaert merged 2 commits into
mainfrom
sections-and-hardening

Conversation

@toddbaert

@toddbaert toddbaert commented Oct 13, 2022

Copy link
Copy Markdown
Member

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>

@beeme1mr beeme1mr left a comment

Copy link
Copy Markdown
Member

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.

Comment thread specification.json Outdated
Comment thread specification/sections/01-flag-evaluation.md
Signed-off-by: Todd Baert <toddbaert@gmail.com>
@toddbaert

toddbaert commented Oct 13, 2022

Copy link
Copy Markdown
Member Author

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 toddbaert requested a review from beeme1mr October 13, 2022 14:10
@toddbaert

toddbaert commented Oct 13, 2022

Copy link
Copy Markdown
Member Author

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

toddbaert commented Oct 17, 2022

Copy link
Copy Markdown
Member Author

@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.

6 participants