Refactor: Address TODOs and document limitations #386
Merged
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
This commit addresses a number of TODO items and potential optimization comments found throughout your codebase. Key changes include: - Verification and Removal of Outdated TODOs: - Confirmed that TODOs in `src/parser.rs` related to `FromStr` for `WeekdayName` and `MonthName` were already addressed or outdated. - The TODO in `src/epoch/gregorian.rs:L427` regarding user-defined format string parsing for `Epoch` remains relevant. - Testing TODOs: - Added new test cases in `tests/epoch.rs` for TDB and ET continuity around the J2000 epoch. - Removed the corresponding TODO comments from `src/epoch/mod.rs`. - Feature TODOs and Documentation: - Updated documentation for the `Frequencies` trait in `src/timeunits.rs` to clarify the limitation for frequencies > 1 GHz. - Implemented parsing for `Token::WeekdayDecimal` (`%w`) in `src/efmt/format.rs`, including input validation for the C89 standard (0-6), and removed the associated TODO. - Build/Verification Tooling TODOs: - Updated comments in `src/epoch/kani_verif.rs` for skipped Kani proofs (ET, TDB, UTC) to provide more specific explanations of the challenges (e.g., Newton-Raphson, floating point precision, leap second list complexity). - Improved type sequence parsing logic in `generate_stubs.py` by making type name joining more robust and removing specific hardcoded hacks. One outstanding TODO remains from `src/epoch/gregorian.rs:L427` for enhancing epoch parsing from strings with user-defined formats.
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.
This commit addresses a number of TODO items and potential optimization comments found throughout your codebase.
Key changes include:
Verification and Removal of Outdated TODOs:
src/parser.rsrelated toFromStrforWeekdayNameandMonthNamewere already addressed or outdated.src/epoch/gregorian.rs:L427regarding user-defined format string parsing forEpochremains relevant.Testing TODOs:
tests/epoch.rsfor TDB and ET continuity around the J2000 epoch.src/epoch/mod.rs.Feature TODOs and Documentation:
Frequenciestrait insrc/timeunits.rsto clarify the limitation for frequencies > 1 GHz.Token::WeekdayDecimal(%w) insrc/efmt/format.rs, including input validation for the C89 standard (0-6), and removed the associated TODO.Build/Verification Tooling TODOs:
src/epoch/kani_verif.rsfor skipped Kani proofs (ET, TDB, UTC) to provide more specific explanations of the challenges (e.g., Newton-Raphson, floating point precision, leap second list complexity).generate_stubs.pyby making type name joining more robust and removing specific hardcoded hacks.One outstanding TODO remains from
src/epoch/gregorian.rs:L427for enhancing epoch parsing from strings with user-defined formats.