Improve readme #131
Improve readme #131
Conversation
## Walkthrough
The changes updated the README.md file to add a new "Installation" section with pip and GitHub instructions, and corrected example date ranges for centuries. Additionally, the version string in the package's __init__.py was incremented from "0.4.0" to "0.5.0.dev0".
## Changes
| File(s) | Change Summary |
|------------------------|-------------------------------------------------------------------------------------------------------|
| README.md | Added "Installation" section with pip and GitHub instructions; corrected example usage for centuries; improved formatting and line wrapping. |
| src/undate/__init__.py | Updated `__version__` from "0.4.0" to "0.5.0.dev0". |
## Poem
> A hop and a skip, the version jumps high,
> README now tells you the how and the why.
> Centuries corrected, instructions anew,
> Pip or from GitHub—install what you do!
> 🐇✨Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
README.md (2)
28-41: Installation instructions look comprehensive.The new Installation section clearly describes how to install from PyPI or GitHub, which addresses the previous omission. Consider adding a note on pinning to the exact dev version (e.g.,
pip install undate==0.5.0.dev0) if users want the latest published development release.
145-146: Enhance example consistency.Currently, the 20th century example shows only the interval object but omits its duration. For consistency with the 19th century example, consider adding a
.duration().daysline and expected output immediately afterward.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
README.md(2 hunks)src/undate/__init__.py(1 hunks)
🔇 Additional comments (1)
src/undate/__init__.py (1)
1-1: Version bump is appropriate.The
__version__has been updated to"0.5.0.dev0"in line with the README changes. Please verify that any other version references (e.g., insetup.py,pyproject.toml, CI/CD workflows, or documentation) are also updated to avoid mismatches.
| >>> UndateInterval(Undate(1900), Undate(2000), label="20th century") | ||
| <UndateInterval '20th century' (1900/2000)> | ||
| >>> UndateInterval(Undate(1801), Undate(1900), label="19th century") | ||
| >>> UndateInterval(Undate(1801), Undate(1900), label="19th century").duration().days |
There was a problem hiding this comment.
Looking at these examples, my first question is are beginning and end values inclusive or exclusive? Looking up the date range for 19th century (which apparently I didn't know 😅), I realize it's inclusive but maybe worth pointing out?
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
README.md (1)
162-166: 19th and 20th century intervals corrected
The string representations and duration calculations for the 19th (1801/1900, 36524 days) and 20th (1901/2000) centuries now accurately reflect the intended ranges.
🧹 Nitpick comments (3)
README.md (3)
28-41: Installation instructions added—consider adding minimum Python version and venv usage
The new Installation section clearly outlines pip and GitHub install options. For completeness, you might mention the supported Python versions (e.g., 3.7+) and recommend using a virtual environment to isolate dependencies.
45-45: Add comma after introductory adverb
For readability, add a comma after “Often”:- Often humanities and cultural data include imprecise or uncertain + Often, humanities and cultural data include imprecise or uncertain
232-233: Replace bare URL with markdown link
Avoid bare URLs to satisfy markdownlint and improve readability; use link syntax:-* For more examples, refer to the code notebooks included in the[examples] (https://github.com/dh-tech/undate-python/tree/main/examples/) in this repository. +* For more examples, refer to the code notebooks included in the [examples](https://github.com/dh-tech/undate-python/tree/main/examples/) in this repository.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
233-233: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(9 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~44-~44: Possible missing comma found.
Context: ...velop#egg=undate ``` ## Example Usage Often humanities and cultural data include im...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~180-~180: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...ut an Undate object in those formats. Currently available converters are "ISO8601" and ...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
🪛 markdownlint-cli2 (0.17.2)
README.md
233-233: Bare URL used
null
(MD034, no-bare-urls)
🔇 Additional comments (1)
README.md (1)
58-58: Simplify import path for users
Switching fromfrom undate.undate import ...tofrom undate import ...is a nice UX improvement and aligns with common package structures.
Summary by CodeRabbit