search

dh-tech / undate-python

A Python library for working with fuzzy, partial, or otherwise uncertain dates
Apache License 2.0
8 stars 1 forks source link

Rename formatters submodule and classes to converters #101

Closed rlskoeser closed 2 weeks ago

rlskoeser commented 2 weeks ago

resolves #100 and #86

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request introduces significant changes to the documentation and structure of the undate library. Key alterations include the renaming of formatter classes to converter classes to accommodate calendar conversion, updates to Sphinx documentation configuration, and the introduction of new documentation files. The modifications also involve the removal of outdated files and the addition of unit tests for the new BaseDateConverter and EDTFDateConverter classes, ensuring comprehensive coverage for the updated functionalities.

Changes

File Change Summary
docs/conf.py Commented out myst_enable_extensions for "linkify", disabling it due to not being found.
docs/index.rst Updated reference from undate to undate/index in the table of contents.
docs/undate.rst Deleted file containing API documentation for Undate and UndateInterval classes.
docs/undate/converters.rst Added new documentation sections for undate.converters.base, undate.converters.iso8601, undate.converters.edtf.converter, and undate.converters.edtf.parser.
docs/undate/core.rst New documentation file introduced outlining Undate and UndateInterval classes along with date-related classes.
docs/undate/index.rst Added new section titled "API documentation" with a table of contents directive.
src/undate/converters/init.py Added import statement for BaseDateConverter from undate.converters.base.
src/undate/converters/base.py Introduced BaseDateConverter class with methods for parsing and converting dates.
src/undate/converters/edtf/init.py Added import statement for EDTFDateConverter from undate.converters.edtf.converter.
src/undate/converters/edtf/converter.py Renamed EDTFDateFormat to EDTFDateConverter, updated inheritance, and enhanced documentation for methods.
src/undate/converters/iso8601.py Changed ISO8601DateFormat class to inherit from BaseDateConverter and updated documentation.
src/undate/dateformat/init.py Removed imports for BaseDateFormat and ISO8601DateFormat.
src/undate/dateformat/base.py Deleted BaseDateFormat class and its associated methods.
src/undate/dateformat/edtf/init.py Removed import for EDTFDateFormat.
src/undate/undate.py Replaced formatter attribute with converter of type BaseDateConverter in Undate and UndateInterval classes.
tests/test_converters/edtf/test_edtf_parser.py Updated import path for edtf_parser to reflect new module organization.
tests/test_converters/edtf/test_edtf_transformer.py Updated import paths for edtf_parser and EDTFTransformer to reflect new module organization.
tests/test_converters/test_base.py Introduced unit tests for BaseDateConverter functionality.
tests/test_converters/test_edtf.py Introduced unit tests for EDTFDateConverter functionality.
tests/test_converters/test_iso8601.py Updated import path for ISO8601DateFormat to reflect new module organization.
tests/test_dateformat/test_base.py Deleted file containing unit tests for BaseDateFormat.
tests/test_dateformat/test_edtf.py Deleted file containing unit tests for EDTFDateFormat.

Assessment against linked issues

Objective Addressed Explanation
Rename formatters to converters so they can include calendar conversion as well as formatting (#100) ✅

Possibly related PRs

Suggested reviewers

Poem

In the garden of code, we hop and play,
With converters anew, we brighten the day.
From formats to functions, we leap with glee,
A world of dates, as clear as can be!
So let’s celebrate this change so bright,
Hopping along, with joy and delight! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 2 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 98.04%. Comparing base (25ba4ad) to head (d7b32d3). Report is 3 commits behind head on develop.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #101 +/- ## =========================================== + Coverage 96.94% 98.04% +1.10% =========================================== Files 10 10 Lines 458 460 +2 =========================================== + Hits 444 451 +7 + Misses 14 9 -5 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

rlskoeser commented 2 weeks ago

@coderabbitai review

coderabbitai[bot] commented 2 weeks ago
:white_check_mark: Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.
review-notebook-app[bot] commented 2 weeks ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB