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

DOC: fix default value for config.REPOSITORIES #492

Merged
merged 2 commits into from
Dec 16, 2024
Merged

DOC: fix default value for config.REPOSITORIES #492

merged 2 commits into from
Dec 16, 2024

Conversation

hagenw
Copy link
Member

@hagenw hagenw commented Dec 16, 2024

Ensures the correct value is shown for audb.config.REPOSITORIES in the documentation.
This is ensured by reading the default config file inside docs/conf.py and extract the value for REPOSITORIES from there.

image

Summary by Sourcery

Documentation:

  • Correct the default value for audb.config.REPOSITORIES in the documentation by dynamically loading it from the default configuration file.

Copy link
Contributor

sourcery-ai bot commented Dec 16, 2024

Reviewer's Guide by Sourcery

The PR updates the documentation to correctly display the default value for audb.config.REPOSITORIES. Instead of hardcoding the repository configuration in the documentation, it now reads the actual default values from the global configuration file.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated repository configuration in documentation build process
  • Added code to load repository configuration from global config file
  • Replaced hardcoded repository with dynamic configuration from loaded file
  • Changed list comprehension to create Repository objects from config data
docs/conf.py
Updated example values in Repository documentation
  • Updated example repository name from 'data-local' to 'audb-public'
  • Changed example backend from 'artifactory' to 's3'
  • Updated example host URL to use AWS S3 endpoint instead of Artifactory
audb/core/config.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
Contributor

@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 @hagenw - 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.

@hagenw hagenw merged commit a6a0050 into main Dec 16, 2024
10 checks passed
@hagenw hagenw deleted the fix-config-doc branch December 16, 2024 12:11
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.

1 participant