Skip to content

Conversation

@jcharkow
Copy link
Contributor

@jcharkow jcharkow commented Dec 2, 2025

Old copyright formatting not rendering properly. Fix this (hopefully)

image

Summary by CodeRabbit

  • Chores
    • Simplified documentation build configuration by streamlining how the copyright year is determined.
    • Removed reliance on runtime timestamp functions during builds to ensure a stable, current-year value.
    • Improves clarity and maintainability of documentation metadata and reduces potential build-time variability.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Dec 2, 2025

Walkthrough

Replaced datetime import and datetime.now().year usage with from datetime import date and date.today().year in the Sphinx docs configuration to compute the copyright year.

Changes

Cohort / File(s) Change Summary
Documentation Configuration
docs/source/conf.py
Replaced import datetime with from datetime import date and switched year computation from datetime.now().year to date.today().year (using an f-string)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Single-file, minimal change in documentation config
  • Review focus: confirm import and year expression updated correctly

Possibly related PRs

Suggested labels

documentation, Review effort [1-5]: 1

Suggested reviewers

  • matteopilz

Poem

🐰 I hopped into conf.py late at night,
Swapped imports quick, made the year just right.
From date.today() I softly sing,
A tiny change — a joyful thing! 🎉

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Fix copyright formatting' directly relates to the main change: updating copyright year formatting in docs/source/conf.py from a datetime.now() expression to a date.today() f-string.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch dynamic_copyright_fix

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ea723e1 and 16708b0.

📒 Files selected for processing (1)
  • docs/source/conf.py (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/source/conf.py
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build-test

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@jcharkow jcharkow marked this pull request as draft December 2, 2025 17:00
@jcharkow jcharkow marked this pull request as ready for review December 2, 2025 17:00
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lintly has detected code quality issues in this pull request.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0bf40fb and ea723e1.

📒 Files selected for processing (1)
  • docs/source/conf.py (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build-test

@jcharkow
Copy link
Contributor Author

jcharkow commented Dec 2, 2025

@timosachsenberg I think this is good to merge. Docs seem to be rendering correctly now.

@timosachsenberg timosachsenberg merged commit 20c040c into master Dec 2, 2025
7 checks passed
@jcharkow jcharkow deleted the dynamic_copyright_fix branch December 2, 2025 21:04
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.

3 participants