docs: Switch to project_copyright

[jmgate]

Type: Documentation

Description

Using this alias means we're no longer overshadowing the copyright built-in, so we can remove the comment to ignore that Ruff linting rule.

Summary by Sourcery

Use the project_copyright alias instead of the built-in copyright to avoid overshadowing it.

Enhancements:

• Removed the Ruff linting rule that ignored the copyright built-in.

Documentation:

• Replaced the usage of the built-in copyright with the project_copyright alias.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request renames the copyright variable to project_copyright in the conf.py file to avoid shadowing the built-in copyright keyword.

Class diagram showing configuration variable change

classDiagram
    class SphinxConfig {
        +String project
        +String project_copyright
        +String author
        note for SphinxConfig "Renamed 'copyright' to 'project_copyright'
to avoid shadowing built-in"
    }

Loading

File-Level Changes

Change	Details	Files
Renamed the copyright variable to project_copyright.	Renamed the copyright variable to project_copyright. Removed the noqa: A001 comment.	doc/source/conf.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @jmgate - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (5dcb3bf) to head (43f1d31).
Report is 46 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master      #169   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines          180       180           
  Branches        15        15           
=========================================
  Hits           180       180           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[jmgate]

@william76, @GhostofGoes, @jcox10, anyone care to review and approve?

[GhostofGoes]

Is this variable referenced anywhere?

[GhostofGoes]

Oh this is in conf.py derp