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

Makes the config module internal #877

Merged
merged 8 commits into from
Dec 21, 2022
Merged

Makes the config module internal #877

merged 8 commits into from
Dec 21, 2022

Conversation

vyasr
Copy link
Contributor

@vyasr vyasr commented Dec 8, 2022

Description

This PR moves signac.config to signac._config, reflecting that all its members are private. To simplify its usage, all the functions that it contains have had their leading underscores removed since they are now redundant.

Motivation and Context

Resolves #874

Checklist:

@vyasr vyasr added this to the v2.0.0 milestone Dec 8, 2022
@vyasr vyasr requested a review from a team as a code owner December 8, 2022 04:20
@vyasr vyasr self-assigned this Dec 8, 2022
@vyasr vyasr requested a review from a team as a code owner December 8, 2022 04:20
@vyasr vyasr requested review from b-butler and syjlee and removed request for a team December 8, 2022 04:20
@codecov
Copy link

codecov bot commented Dec 8, 2022

Codecov Report

Merging #877 (6bbfd86) into master (16a33c7) will increase coverage by 0.10%.
The diff coverage is 86.95%.

@@            Coverage Diff             @@
##           master     #877      +/-   ##
==========================================
+ Coverage   86.51%   86.61%   +0.10%     
==========================================
  Files          39       41       +2     
  Lines        4522     4580      +58     
  Branches      901      901              
==========================================
+ Hits         3912     3967      +55     
- Misses        429      432       +3     
  Partials      181      181              
Impacted Files Coverage Δ
signac/_config.py 90.47% <ø> (ø)
signac/__main__.py 77.76% <80.00%> (+0.03%) ⬆️
signac/migration/v1_to_v2.py 88.37% <100.00%> (ø)
signac/project.py 89.96% <100.00%> (ø)
signac/errors.py 93.18% <0.00%> (ø)
signac/__init__.py 100.00% <0.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Member

@b-butler b-butler left a comment

Choose a reason for hiding this comment

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

I just have one comment about our import in signac/project.py.

signac/project.py Outdated Show resolved Hide resolved
Copy link
Member

@b-butler b-butler left a comment

Choose a reason for hiding this comment

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

👍

@vyasr vyasr merged commit 444e1d2 into master Dec 21, 2022
@vyasr vyasr deleted the refactor/hide_config branch December 21, 2022 00:57
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.

Make config module internal
3 participants