Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Switch to project_copyright #258

Merged
merged 1 commit into from
Jan 21, 2025
Merged

docs: Switch to project_copyright #258

merged 1 commit into from
Jan 21, 2025

Conversation

jmgate
Copy link
Collaborator

@jmgate jmgate commented Jan 21, 2025

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

Documentation:

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

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.
@jmgate jmgate self-assigned this Jan 21, 2025
Copy link

sourcery-ai bot commented Jan 21, 2025

Reviewer's Guide by Sourcery

The pull request renames the copyright variable to project_copyright in the conf.py file to avoid shadowing the built-in copyright keyword. This change also removes the need to ignore the Ruff linting rule.

Class diagram showing configuration variable change

classDiagram
    class conf.py {
        +String project
        -String copyright (removed)
        +String project_copyright (added)
        +String author
    }
    note for conf.py "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

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

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 ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

codecov bot commented Jan 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.97%. Comparing base (907370e) to head (d0a21d5).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #258   +/-   ##
=======================================
  Coverage   93.97%   93.97%           
=======================================
  Files           2        2           
  Lines         166      166           
  Branches       37       37           
=======================================
  Hits          156      156           
  Misses          4        4           
  Partials        6        6           

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

@jmgate
Copy link
Collaborator Author

jmgate commented Jan 21, 2025

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

@GhostofGoes
Copy link
Collaborator

Is this variable referenced anywhere?

@jmgate jmgate merged commit 9f531cb into master Jan 21, 2025
14 checks passed
@jmgate jmgate deleted the project-copyright branch January 21, 2025 19:02
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