8000 DOC: Fix references to SymmetricalLogScale. by QuLogic · Pull Request #16817 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

DOC: Fix references to SymmetricalLogScale. #16817

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 18, 2020
Merged

DOC: Fix references to SymmetricalLogScale. #16817

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,10 +312,9 @@ longer necessary to import mplot3d to create 3d axes with ::
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Previously, `.SymLogNorm` had no *base* keyword argument and the base was
hard-coded to ``base=np.e``. This was inconsistent with the default
behavior of `.SymLogScale` (which defaults to ``base=10``) and the use
of the word "decade" in the documentation.
hard-coded to ``base=np.e``. This was inconsistent with the default behavior of
`.SymmetricalLogScale` (which defaults to ``base=10``) and the use of the word
"decade" in the documentation.

In preparation for changing the default base to 10, calling
`.SymLogNorm` without the new *base* kwarg emits a deprecation
warning.
In preparation for changing the default base to 10, calling `.SymLogNorm`
without the new *base* keyword argument emits a deprecation warning.
7 changes: 4 additions & 3 deletions doc/api/prev_api_changes/api_changes_3.2.0/deprecations.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,10 +232,11 @@ deprecated. Use an explicit list instead.

Scales
~~~~~~
Passing unsupported keyword arguments to `.ScaleBase` and its subclasses
`.LinearScale`, and `.SymLogScale` is deprecated and will raise a `TypeError` in 3.3.
Passing unsupported keyword arguments to `.ScaleBase`, and its subclasses
`.LinearScale` and `.SymmetricalLogScale`, is deprecated and will raise a
`TypeError` in 3.3.

If extra kwargs are passed to `.LogScale`, `TypeError` will now be
If extra keyword arguments are passed to `.LogScale`, `TypeError` will now be
raised instead of `ValueError`.

Testing
Expand Down
3 changes: 0 additions & 3 deletions doc/missing-references.json
79B6
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -933,9 +933,6 @@
"Locator.view_limits()": [
"doc/api/prev_api_changes/api_changes_3.2.0/deprecations.rst:113"
],
"SymLogScale": [
"doc/api/prev_api_changes/api_changes_3.2.0/deprecations.rst:224"
],
"GraphicsContextBase": [
"lib/matplotlib/backends/backend_agg.py:docstring of matplotlib.backends.backend_agg.RendererAgg.draw_text:8",
"lib/matplotlib/backends/backend_cairo.py:docstring of matplotlib.backends.backend_cairo.RendererCairo.draw_image:8",
Expand Down
0