Fix inaccurate wording in multiple decimal module docstrings - #155688
Open
lpyu001 wants to merge 1 commit into
Open
Fix inaccurate wording in multiple decimal module docstrings#155688lpyu001 wants to merge 1 commit into
lpyu001 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.
Summary
Fix five inaccurate or misleading
decimal.Contextdocstrings. These changes only update documentation and generated Argument Clinic output; runtime behavior is unchanged.1.
Context.Etop()can return a negative valueRemove the statement that
Etop()must not be negative. A valid custom context can haveEmax < prec - 1, soEmax - prec + 1can be negative.2.
Context.power()exactness depends on exponentbCorrect the exactness condition from base
abeing integral to exponentbbeing integral. A non-integral base raised to an integral exponent can produce an exact result.3.
Context.canonical()returns its argument unchangedClarify that
canonical()returnsxunchanged. The C implementation returns another reference to the original object rather than creating a newDecimalinstance.4.
_pydecimal.Context.number_class()returns unsigned NaN class namesCorrect the documented class names from
-NaNand-sNaNtoNaNandsNaN. The sign of a NaN is not included in the returned classification string.5.
_pydecimal.Context.to_integral_value()can signal other conditionsClarify that
to_integral_value()suppresses only theInexactandRoundedflags, not all flags. For example, ansNaNstill signalsInvalidOperation.Argument Clinic output is regenerated for the C docstring changes.