Repository navigation
docs(arch): tighten the architecture diagram prose and guard - #1126
Merged
Merged
Conversation
Plain wording throughout docs/architecture.md, and no hand-copied counts that a code change can falsify. Diagrams and the guard are unchanged. Refs #1098
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.
Rewrites prose in
docs/architecture.mdthat read as padding or jargon, and removes counts copied from code that had gone stale. Every diagram is unchanged, and so is the guardCouplingMatrixRealTreeTests.RealTree_FeatureModuleDiagramNamesExactlyTheLedgerOwners.Follows #1098, whose code and prose were never cleaned up.
What changed
Use*registrations, seven terminal/map registrations, andapp.Run())".Program.cson main has 22app.Use*calls but far more than seven map lines. The new text says the diagram shows only the steps whose order matters and points toProgram.csfor the full list.LockAfterDaysin place of a copied "7". The diagram label still reads "7 days", because the diagrams are unchanged.Untouched: the four diagrams; the two table rows changed in #1124; the guard, which deslop found clean.
Claims checked against code
DailyEntryLockSweep.LockAfterDays = 7/errorre-executionFlockScopeResolutionMiddleware.cs,IExceptionHandlerFeaturecheckRestrictedUntilSetWithdrawalRestrictionis called only from testsShippedandInvoicedstay zeroSimulationDataSeeder.cs, twoCheck(... == 0)linesProof
Financenode from the feature-modules diagram, and the guard turned red:Assert.Equal() Failure: Collections differ, with"Finance"expected but missing. I restored the file before committing.CouplingMatrixRealTreeTestsandTenancyDocsFreshnessTestspass 4/4. TheSchemaDocsTestsimage-pin guards pass 2/2.