Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit d7420fb

Browse files
committed
DOC: merge new whats_new and api_changes into top level doc
1 parent df6acf9 commit d7420fb

7 files changed

+77
-66
lines changed

doc/api/api_changes.rst

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,72 @@ For new features that were added to Matplotlib, please see
1313
API Changes in 2.1.0
1414
====================
1515

16+
cbook deprecations
17+
------------------
18+
19+
Many unused or near-unused cbook functions and classes have been deprecated:
20+
``converter``, ``tostr``, ``todatetime``, ``todate``, ``tofloat``, ``toint``,
21+
``unique``, ``is_string_like``, ``is_sequence_of_strings``, ``is_scalar``,
22+
``Sorter``, ``Xlator``, ``soundex``, ``Null``, ``dict_delall``, ``RingBuffer``,
23+
``get_split_ind``, ``wrap``, ``get_recursive_filelist``, ``pieces``,
24+
``exception_to_str``, ``allequal``, ``alltrue``, ``onetrue``, ``allpairs``,
25+
``finddir``, ``reverse_dict``, ``restrict_dict``, ``issubclass_safe``,
26+
``recursive_remove``, ``unmasked_index_ranges``.
27+
28+
29+
Improved Delaunay triangulations with large offsets
30+
---------------------------------------------------
31+
32+
Delaunay triangulations now deal with large x,y offsets in a better
33+
way. This can cause minor changes to any triangulations calculated
34+
using Matplotlib, i.e. any use of `matplotlib.tri.Triangulation` that
35+
requests that a Delaunay triangulation is calculated, which includes
36+
`matplotlib.pyplot.tricontour`, `matplotlib.pyplot.tricontourf`,
37+
`matplotlib.pyplot.tripcolor`, `matplotlib.pyplot.triplot`,
38+
`mlab.griddata` and `mpl_toolkits.mplot3d.plot_trisurf`.
39+
40+
41+
Deprecation in EngFormatter
42+
---------------------------
43+
44+
Passing a string as *num* argument when calling an instance of
45+
`matplotlib.ticker.EngFormatter` is deprecated and will be removed in 2.3.
46+
47+
48+
:meth:`matpltolib.cbook.CallbackRegistry.process` suppresses exceptions by default
49+
----------------------------------------------------------------------------------
50+
51+
Matplotlib uses instances of :obj:`~matplotlib.cbook.CallbackRegistry`
52+
as a bridge between user input event from the GUI and user callbacks.
53+
Previously, any exceptions raised in a user call back would bubble out
54+
of of the ``process`` method, which is typically in the GUI event
55+
loop. Most GUI frameworks simple print the traceback to the screen
56+
and continue as there is not always a clear method of getting the
57+
exception back to the user. However PyQt5 now exits the process when
58+
it receives and un-handled python exception in the event loop. Thus,
59+
:meth:`~matplotlib.cbook.CallbackRegistry.process` now suppresses and
60+
prints tracebacks to stderr by default.
61+
62+
What :meth:`~matplotlib.cbook.CallbackRegistry.process` does with exceptions
63+
is now user configurable via the ``exception_handler`` attribute and kwarg. To
64+
restore the previous behavior pass ``None`` ::
65+
66+
cb = CallbackRegistry(exception_handler=None)
67+
68+
69+
A function which take and ``Exception`` as its only argument may also be passed ::
70+
71+
def maybe_reraise(exc):
72+
if isinstance(exc, RuntimeError):
73+
pass
74+
else:
75+
raise exc
76+
77+
cb = CallbackRegistry(exception_handler=maybe_reraise)
78+
79+
80+
81+
1682
`mpl_toolkits.axes_grid` has been deprecated
1783
--------------------------------------------
1884

doc/api/api_changes/2017-05-22-cbook-deprecations.rst

Lines changed: 0 additions & 11 deletions
This file was deleted.

doc/api/api_changes/2017-07-14-IT_qhull_large_offset.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.

doc/api/api_changes/2017-08-24-deprecation-in-engformatter.rst

Lines changed: 0 additions & 5 deletions
This file was deleted.

doc/api/api_changes/2017-08_TAC.rst

Lines changed: 0 additions & 30 deletions
This file was deleted.

doc/users/whats_new.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -420,6 +420,17 @@ Examples of use
420420
contour.negative_linestyle : dashdot # previously only solid or dashed
421421

422422

423+
New keyword argument 'sep' for EngFormatter
424+
-------------------------------------------
425+
426+
A new "sep" keyword argument has been added to
427+
:class:`~matplotlib.ticker.EngFormatter` and provides a means to define
428+
the string that will be used between the value and its unit. The default
429+
string is " ", which preserves the former behavior. Besides, the separator is
430+
now present between the value and its unit even in the absence of SI prefix.
431+
There was formerly a bug that was causing strings like "3.14V" to be returned
432+
instead of the expected "3.14 V" (with the default behavior).
433+
423434

424435
Previous Whats New
425436
==================

doc/users/whats_new/EngFormatter_new_kwarg_sep.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)