Fix incorrect precision example in GeometricWidthDiscretiser docs - #986
Open
maupatel wants to merge 1 commit into
Open
Fix incorrect precision example in GeometricWidthDiscretiser docs#986maupatel wants to merge 1 commit into
maupatel wants to merge 1 commit into
Conversation
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.
The
GeometricWidthDiscretiserguidance on theprecisionparameter gives an inconsistent worked example.precisionis the number of decimal places (forwarded topd.cut(..., precision=...)), soprecision = Ncorresponds to a smallest step of10**-N. The tip establishes this with its first example (precision = 3->0.001), but then statesprecision = 7->0.0001, which is10**-4, not10**-7. The correct value is0.0000001.Fixed in both places the sentence appears (kept in sync):
feature_engine/discretisation/geometric_width.py(docstring)docs/user_guide/discretisation/GeometricWidthDiscretiser.rstDocumentation-only; no code or behavior changes.