Document the package and cover with tests - #1
Open
alemohamad wants to merge 1 commit into
Open
Conversation
This file contains hidden or 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
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.
What this is
Documentation and tests for
MIOEntityCore. No behavior changes: every source edit is a comment, and the test suite goes from 2 tests to 41.MECCacheandMECModelMECEntityCacheREADMEwas expanded for a brief presentation of the packageHow the content was arrived at, and why you should push back on it
Most of this is inference. I had no design document. The descriptions come from reading the implementation and from reviewing how a production consumer actually calls it. I turned claims into a test so it is checked rather than assumed, but the framing and the explanations are still my opinions, not a record of anyone's intent.
That means some of it will be wrong in ways only you can see. A few specific places worth a careful look:
Rewrite anything that does not sound right. The aim is that anybody who picks this package up for the first time can work out which of the two caches they want and avoid unintended implementations, so clearer wording beats what I wrote. Correcting a description here will be much cheaper than someone learning it without context later.