fix: correct the get_parkinson_vol spelling in the public API - #24
Merged
Conversation
The Rust fn and the Python binding both spelled Parkinson as 'parksinson'. The pyfunction name IS the public Python API, so this is a deliberate breaking rename, made on the owner's instruction. Renamed: openquant::util::volatility::get_parksinson_vol -> get_parkinson_vol, the pyopenquant wrapper, its #[pyfunction(name = ...)], its module registration, and the volatility_features test. The doc comment still names mlfinlab's 'get_parksinson_vol' because that misspelling is upstream's and is where ours came from; the comment now says so rather than propagating it silently.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replaces #23, which GitHub auto-closed when its base branch (
chore/cargo-fmt-pyopenquant, now merged as #20) was deleted. Same commit, retargeted tomain.Breaking change, made on the owner's instruction.
Parkinsonwas spelledparksinsonin both the Rust function and the Python binding. Because#[pyfunction(name = "get_parksinson_vol")]is the public Python API, correcting it breaksdownstream callers — which is why it was raised before being fixed.
Renamed:
openquant::util::volatility::get_parksinson_vol→get_parkinson_volpyopenquantwrapper fn, its#[pyfunction(name = …)], and its module registrationcrates/openquant/tests/volatility_features.rsOne thing deliberately left misspelled
The doc comment still names mlfinlab's
get_parksinson_vol, because that misspelling isupstream's and is where ours came from. It now says so rather than propagating it silently.
Verification
cargo fmt -- --check→ 0 ·cargo test --package openquant --test volatility_features→ 0 (1 passed) ·cargo check --package pyopenquant→ 0Follow-up
moduleDocs.tsand the generatedmodules/util-volatility.mdstill carry the old name in fourplaces. Not fixed here — this branch carries the pre-#18 page generator, so regenerating from it
would revert the honest-status work. Tracked; #21's
check:examplesgate will fail loudly until itis done, which is correct.