Skip to content

docs: improve README with precision explanation and acknowledgments#5

Merged
devAbreu merged 2 commits intomainfrom
development
May 27, 2025
Merged

docs: improve README with precision explanation and acknowledgments#5
devAbreu merged 2 commits intomainfrom
development

Conversation

@devAbreu
Copy link
Owner

Overview

This PR enhances the documentation by adding clearer explanations about moneyx's precision enforcement and adds proper acknowledgments to our inspiration sources.

Changes

  • Added explanation about moneyx's strict enforcement of currency-specific decimal places
  • Added concrete examples of invalid monetary values (3.678 USD, 5.5 JPY)
  • Added acknowledgments section crediting py-money by Vimeo as inspiration
  • Improved formatting consistency throughout the README

Type of change

  • Documentation update (no code changes)

No version bump is needed as this is a documentation-only change.

@codecov-commenter
Copy link

codecov-commenter commented May 27, 2025

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@devAbreu devAbreu merged commit 075ecc1 into main May 27, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants