-
Notifications
You must be signed in to change notification settings - Fork 113
Code quality and documentation improvements #381
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
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
…cal functions and provide usage examples
… and improve conversion to units
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 pull request introduces several documentation improvements and code enhancements to the RubyUnits library, focusing on clarifying usage, extending features, and improving configuration flexibility. The most significant changes are detailed updates to the
README.mdto provide clearer examples, expanded explanations of time and math operations, and new configuration options. Additionally, the codebase now supports more robust and explicit handling of date arithmetic and configuration management.Documentation improvements:
README.mdto provide detailed examples of string formatting with units, direct string-to-unit conversions, and comprehensive explanations of time helpers, including adding/subtracting durations, converting betweenTime/Dateand units, and handling large time units with calendar accuracy. Added sections on math functions, new unit definitions, and configuration options. [1] [2] [3] [4] [5] [6]README.md.Configuration enhancements:
default_precisionoption to theRubyUnits::Configurationclass, allowing users to control the precision used when rationalizing fractional values in unit output. Updated documentation and code to support and explain new and legacy configuration options, including improved validation and deprecation warnings for booleanseparatorvalues. [1] [2] [3]Date arithmetic improvements:
RubyUnits::Datemodule to provide more explicit and accurate handling of adding and subtracting durations to/fromDateobjects, especially for large time units (years, decades, centuries). The new implementation ensures durations are converted to days and rounded as needed for calendar accuracy, with improved documentation and private helper methods.Development tooling:
ruby-lspgem as an optional development dependency in theGemfileto improve language server support.