Skip to content

Update ConfigEntry docstring to sync with attributes#852

Merged
nathanjmcdougall merged 2 commits intomainfrom
851-update-configentry-docstring
Jul 14, 2025
Merged

Update ConfigEntry docstring to sync with attributes#852
nathanjmcdougall merged 2 commits intomainfrom
851-update-configentry-docstring

Conversation

@nathanjmcdougall
Copy link
Copy Markdown
Collaborator

No description provided.

@nathanjmcdougall nathanjmcdougall requested a review from Copilot July 14, 2025 19:21
@nathanjmcdougall nathanjmcdougall linked an issue Jul 14, 2025 that may be closed by this pull request
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the docstring for the ConfigEntry class to align with its current implementation. The documentation previously referenced a value attribute but has been corrected to reflect the actual get_value attribute.

  • Updated the ConfigEntry docstring to document get_value instead of value
  • Corrected the attribute description to specify it's a callable rather than a direct value

@codecov
Copy link
Copy Markdown

codecov bot commented Jul 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq bot commented Jul 14, 2025

CodSpeed Instrumentation Performance Report

Merging #852 will not alter performance

Comparing 851-update-configentry-docstring (960ae61) with main (972cbb5)

Summary

✅ 2 untouched benchmarks

@nathanjmcdougall nathanjmcdougall merged commit c694f81 into main Jul 14, 2025
20 checks passed
@nathanjmcdougall nathanjmcdougall deleted the 851-update-configentry-docstring branch July 14, 2025 19:56
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.

Update ConfigEntry docstring

2 participants