8000 Fix documentation markup issues · matplotlib/matplotlib@c10ebca · GitHub
[go: up one dir, main page]

Skip to content

Commit c10ebca

Browse files
committed
Fix documentation markup issues
1 parent aeb0692 commit c10ebca

File tree

3 files changed

+18
-12
lines changed

3 files changed

+18
-12
lines changed

doc/api/next_api_changes/removals/22107-OG.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ Removal of deprecated ``mathtext`` APIs
22
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33

44
The following `matplotlib.mathtext` APIs have been removed:
5+
56
- ``Fonts`` and all its subclasses,
67
- ``FontConstantsBase`` and all its subclasses,
78
- ``Node`` and all its subclasses,
@@ -18,15 +19,19 @@ Removal of various ``mathtext`` helpers
1819
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1920

2021
The following `matplotlib.mathtext` classes:
22+
2123
- ``MathtextBackendPdf``,
2224
- ``MathtextBackendPs``,
2325
- ``MathtextBackendSvg``,
2426
- ``MathtextBackendCairo``,
27+
2528
and the ``.mathtext_parser`` attributes on
29+
2630
- `.RendererPdf`,
2731
- `.RendererPS`,
2832
- `.RendererSVG`,
2933
- `.RendererCairo`
34+
3035
have been removed. The `.MathtextBackendPath` class can be used instead.
3136

3237
The methods ``get_depth``, ``parse``, ``to_mask``, ``to_rgba``, and ``to_png``

doc/devel/MEP/MEP27.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@ Status
1313
Branches and Pull requests
1414
==========================
1515
Main PR (including GTK3):
16+
1617
+ https://github.com/matplotlib/matplotlib/pull/4143
1718

1819
Backend specific branch diffs:
20+
1921
+ https://github.com/OceanWolf/matplotlib/compare/backend-refactor...OceanWolf:backend-refactor-tkagg
2022
+ https://github.com/OceanWolf/matplotlib/compare/backend-refactor...OceanWolf:backend-refactor-qt
2123
+ https://github.com/OceanWolf/matplotlib/compare/backend-refactor...backend-refactor-wx
@@ -49,15 +51,14 @@ Two main places for generic code appear in the classes derived from
4951

5052
1. ``FigureManagerBase`` has **three** jobs at the moment:
5153

52-
1. The documentation describes it as a *``Helper class for pyplot
53-
mode, wraps everything up into a neat bundle''*
54+
1. The documentation describes it as a *Helper class for pyplot
55+
mode, wraps everything up into a neat bundle*
5456
2. But it doesn't just wrap the canvas and toolbar, it also does
5557
all of the windowing tasks itself. The conflation of these two
56-
tasks gets seen the best in the following line: ```python
57-
self.set_window_title("Figure %d" % num) ``` This combines
58+
tasks gets seen the best in the following line:
59+
``self.set_window_title("Figure %d" % num)`` This combines
5860
backend specific code ``self.set_window_title(title)`` with
5961
matplotlib generic code ``title = "Figure %d" % num``.
60-
6162
3. Currently the backend specific subclass of ``FigureManager``
6263
decides when to end the mainloop. This also seems very wrong
6364
as the figure should have no control over the other figures.
@@ -95,7 +96,7 @@ The description of this MEP gives us most of the solution:
9596
1. This allows us to break up the conversion of backends into
9697
separate PRs as we can keep the existing ``FigureManagerBase``
9798
class and its dependencies intact.
98-
2. and this also anticipates MEP22 where the new
99+
2. And this also anticipates MEP22 where the new
99100
``NavigationBase`` has morphed into a backend independent
100101
``ToolManager``.
101102

doc/users/explain/interactive_guide.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -431,10 +431,10 @@ method. The source for the ``prompt_toolkit`` input hooks lives at
431431
.. rubric:: Footnotes
432432

433433
.. [#f1] A limitation of this design is that you can only wait for one
434-
input, if there is a need to multiplex between multiple sources
435-
then the loop would look something like ::
434+
input, if there is a need to multiplex between multiple sources
435+
then the loop would look something like ::
436436
437-
fds = [...]
437+
fds = [...]
438438
while True: # Loop
439439
inp = select(fds).read() # Read
440440
eval(inp) # Evaluate / Print
@@ -443,6 +443,6 @@ method. The source for the ``prompt_toolkit`` input hooks lives at
443443
<https://www.youtube.com/watch?v=ZzfHjytDceU>`__ if you must.
444444
445445
.. [#f3] These examples are aggressively dropping many of the
446-
complexities that must be dealt with in the real world such as
447-
keyboard interrupts, timeouts, bad input, resource
448-
allocation and cleanup, etc.
446+
complexities that must be dealt with in the real world such as
447+
keyboard interrupts, timeouts, bad input, resource
448+
allocation and cleanup, etc.

0 commit comments

Comments
 (0)
0