Skip to content

0.31.1

Compare
Choose a tag to compare
@jagerber48 jagerber48 released this 07 Jan 04:02
· 444 commits to main since this release
5aac95c

0.31.1 (2024-01-06)

Removed

  • [BREAKING] Removed the SciNumUnc class. Now the SciNum class can be used with an optional second positional argument to specify the uncertainty associated with a number.

  • [BREAKING] Remove separator configuration from the FSML. These options made the FSML to cumbersome and led to confusing (if not incorrect) conflicts with the round mode symbol. Now all separator configuration needs to be done by setting the global format options or using the global format options context manager. [#29]

Added

  • Added annotated examples demonstrating the FSML.
  • Added more documentation for contributing developers.
  • Added `pre-commit (https://pre-commit.com/) configuration.

Changed

  • [BREAKING] Renamed multiple options.

    • top_dig_place renamed to left_pad_dec_place.
    • superscript_exp renamed to superscript.
    • bracket_unc renamed to paren_uncertainty.
    • bracket_unc_remove_seps renamed to
      paren_uncertainty_separators. This change is associated with a
      a reversal of the Boolean logic on the option.
    • val_unc_match_widths renamed to left_pad_matching.
    • unc_pm_whitespace renamed to pm_whitespace.
  • [BREAKING] Previously specifying any left pad decimal place using the sciform FSML resulted in setting left_pad_matching=True so that print(f"{SciNum(123.456, 0.789):0}") resulted in "123.456 ± 000.789". Now the FSML has no impact on left_pad_matching. Now, similar to many other options, the global setting for left_pad_matching will always be used when formatting using the FSML. Under the default global options (left_pad_matching=False) print(f"{SciNum(123.456, 0.789):0}") results in "123.456 ± 0.789".

  • Implemented ruff linting and formatting in codebase and integration automation.

  • Refactored code for adding separators.

  • Refactored formatting and formatting utilities to simplify functions and make the algorithm easier to follow.

  • More aggressively filter JetBrains .idea/ folder from version control.

Fixed

  • Fixed a bug involving removing separators in parentheses uncertainty mode when at least one of the value and uncertainty were non-finite.
  • Fixed a typo that prevented pushing 0.31.0 readme to pypi.