Skip to content

Rename threshhold to threshold#447

Merged
tsmbland merged 2 commits intodevelopfrom
threshhold
Aug 8, 2024
Merged

Rename threshhold to threshold#447
tsmbland merged 2 commits intodevelopfrom
threshhold

Conversation

@tsmbland
Copy link
Copy Markdown
Collaborator

@tsmbland tsmbland commented Aug 7, 2024

Description

Renames the incorrect spelling "threshhold" in three parameters. I've also added a warning if a user attempts to use "asset_threshhold" in the settings file. This isn't required for the other two parameters, see here

Apparently none of these parameters are explained in the documentation, so there's nothing that needs changing in the documentation, but this obviously isn't a good thing!

Fixes #301

Type of change

Please add a line in the relevant section of
CHANGELOG.md to
document the change (include PR #) - note reverse order of PR #s.

  • New feature (non-breaking change which adds functionality)
  • Optimization (non-breaking, back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (whatever its nature)

Key checklist

  • All tests pass: $ python -m pytest
  • The documentation builds and looks OK: $ python -m sphinx -b html docs docs/build

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@tsmbland tsmbland marked this pull request as ready for review August 7, 2024 16:14
@tsmbland tsmbland requested a review from alexdewar August 7, 2024 16:14
@codecov
Copy link
Copy Markdown

codecov Bot commented Aug 7, 2024

Codecov Report

Attention: Patch coverage is 62.50000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 71.31%. Comparing base (0355d08) to head (c44d409).

Files Patch % Lines
src/muse/sectors/subsector.py 0.00% 2 Missing and 1 partial ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #447      +/-   ##
===========================================
- Coverage    71.35%   71.31%   -0.04%     
===========================================
  Files           44       44              
  Lines         5878     5881       +3     
  Branches      1152     1153       +1     
===========================================
  Hits          4194     4194              
- Misses        1364     1366       +2     
- Partials       320      321       +1     

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

Copy link
Copy Markdown
Member

@alexdewar alexdewar left a comment

Choose a reason for hiding this comment

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

LGTM! Good idea to warn users if they use the old option name.

@tsmbland tsmbland merged commit b2220a6 into develop Aug 8, 2024
@tsmbland tsmbland deleted the threshhold branch August 8, 2024 08:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

[BUG] Fix spelling "threshhold" -> "threshold"

2 participants