Repository navigation
chore: rewrite code comments that cite old plan codes - #46
Merged
Merged
Conversation
The Mailpit container is gone, so the AppHost comment and the local environment guide no longer talk about containers, names and connection strings in the plural.
Codes like T12 and D3 came from the plans of closed issues and point to nothing in the repository. The comments now explain themselves, as the coding conventions ask. Only comments and the testing guide change.
Three comments cited a rule that does not say what they claim (USR-16, CNV-20); they now give the reason in words. The test-only endpoint comment no longer says the API has no authenticated route, and the resource section of the local environment guide is consistently in the singular.
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.
Closes #39
What
Rewrites the code comments that cite plan codes of closed issues (
T12,D3,D3 of #7,plan of #7) so they explain themselves, and puts three sentences in the singular now that only one container is left (AppHost.cs,local-environment.md). Also updates one sentence oftesting.mdthat cited "D5". Only comments and the two guides change.Why
The coding conventions say a comment explains itself and cites at most business rule IDs. The plan codes pointed to nothing in the repository, and
T5looked like the test IDs of the new flow (#34-T05).Tests
No numbered tests: the issue does not change behavior. It is covered by the acceptance searches below and by the whole suite (243 tests before and after, all green).
How to test
Checklist
check.ps1passes locally: build without warnings and all testsdocs/, README) when behavior or decisions changed