Open
Conversation
- Expand README with ChronosTime, setTestNow, and ClockFactory examples - Improve ClockFactory class and method documentation - Add detailed docs for createInterval() explaining rollover behavior - Improve average() docs with example showing midpoint calculation - Improve diffFiltered() docs with callback signature and example - Improve nthOfMonth/Quarter/Year docs explaining false return case
- Clarify @param for $dayOfWeek to specify Chronos constants - Improve min() docs explaining it returns the earlier datetime - Improve max() docs explaining it returns the later datetime - Document that null defaults to current time for min/max
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
1 participant
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.
Summary
Addresses documentation gaps identified in the codebase:
setTestNow(), and ClockFactory (PSR-20) examplescreateInterval()explaining time unit rollover behavioraverage()docs with example showing midpoint calculationdiffFiltered()docs with callback signature and usage examplenthOfMonth/Quarter/Yeardocs explaining the false return caseThe README now covers more of the public API including commonly used testing utilities.