From c6d6d91fef21e4603312fad02d664b9ad4ec3221 Mon Sep 17 00:00:00 2001 From: Matthew Morrison Date: Mon, 3 Apr 2023 22:12:12 -0400 Subject: [PATCH 01/16] Minor changes to user_explain\text\README.txt Wanted to implement a redirect to the examples' page for text, labels, and annotations, similar to the user_explain\colors\README.txt --- galleries/users_explain/text/README.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/galleries/users_explain/text/README.txt b/galleries/users_explain/text/README.txt index 8fe69bc0dba7..3ceeb20e7dd9 100644 --- a/galleries/users_explain/text/README.txt +++ b/galleries/users_explain/text/README.txt @@ -5,8 +5,10 @@ Text ---- -matplotlib has extensive text support, including support for +Matplotlib has extensive text support, including support for mathematical expressions, truetype support for raster and vector outputs, newline separated text with arbitrary rotations, and Unicode support. These tutorials cover the basics of working with text in Matplotlib. + +For even more information see the :ref:`examples page <_text_labels_and_annotations>`. From 7b95fb17375b301513b1187b619476ad52cda8e2 Mon Sep 17 00:00:00 2001 From: Matthew Morrison Date: Mon, 3 Apr 2023 22:15:37 -0400 Subject: [PATCH 02/16] Minor changes to user_explain\text\README.txt Wanted to implement a redirect to the examples' page for text, labels, and annotations, similar to the user_explain\colors\README.txt --- galleries/users_explain/text/README.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/galleries/users_explain/text/README.txt b/galleries/users_explain/text/README.txt index 3ceeb20e7dd9..f895fcf1e300 100644 --- a/galleries/users_explain/text/README.txt +++ b/galleries/users_explain/text/README.txt @@ -11,4 +11,4 @@ vector outputs, newline separated text with arbitrary rotations, and Unicode support. These tutorials cover the basics of working with text in Matplotlib. -For even more information see the :ref:`examples page <_text_labels_and_annotations>`. +For even more information see the :ref:`examples page `. From 956c3335cf1f30101d3a6cb651e062a0c23d0fba Mon Sep 17 00:00:00 2001 From: Matthew Morrison Date: Wed, 5 Apr 2023 10:38:17 -0400 Subject: [PATCH 03/16] Some minor typo/text changes in text/README.txt. Some capitalization issues, or capitalizing certain words (TrueType) that is typically capitalized --- galleries/users_explain/text/README.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/galleries/users_explain/text/README.txt b/galleries/users_explain/text/README.txt index f895fcf1e300..9046e991c924 100644 --- a/galleries/users_explain/text/README.txt +++ b/galleries/users_explain/text/README.txt @@ -6,7 +6,7 @@ Text ---- Matplotlib has extensive text support, including support for -mathematical expressions, truetype support for raster and +mathematical expressions, TrueType support for raster and vector outputs, newline separated text with arbitrary rotations, and Unicode support. These tutorials cover the basics of working with text in Matplotlib. From 37a7250ea3e3df6558abc09bc64830ca484f55ba Mon Sep 17 00:00:00 2001 From: Matthew Morrison Date: Tue, 18 Apr 2023 13:19:59 -0400 Subject: [PATCH 04/16] Cookie cutter index overviewing the page and its tutorials. Need to move/write examples that cover using and modifying axis objects (probably in axisartist module on the examples page) --- galleries/users_explain/axis/index.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/galleries/users_explain/axis/index.rst b/galleries/users_explain/axis/index.rst index e6b8b81c8018..b6ec7c61efbe 100644 --- a/galleries/users_explain/axis/index.rst +++ b/galleries/users_explain/axis/index.rst @@ -3,4 +3,11 @@ Controlling and labelling Axis objects -------------------------------------- +Matplotlib ``~matplotlib.axis.Axis` objects can be controlled and manipulated +using the `~matplotlib.artist.Artist` class. These tutorials cover the basics +of the usage of Axis objects and controlling them in Matplotlib. + +For even more information see the :ref: `examples page ` + + Some good material in artist tutorial that should be cribbed from or used here. From 237a5dbde6f7b6c4c4029439fdde33b0101f0195 Mon Sep 17 00:00:00 2001 From: Matthew Morrison Date: Tue, 18 Apr 2023 13:40:27 -0400 Subject: [PATCH 05/16] Added reference link to tutorial on artist. Fixed reference to axis artist reference page Need to move/write examples that cover using and modifying axis objects (probably in axisartist module on the examples page) --- galleries/users_explain/axis/index.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/galleries/users_explain/axis/index.rst b/galleries/users_explain/axis/index.rst index b6ec7c61efbe..1ea5c0159ff1 100644 --- a/galleries/users_explain/axis/index.rst +++ b/galleries/users_explain/axis/index.rst @@ -7,7 +7,11 @@ Matplotlib ``~matplotlib.axis.Axis` objects can be controlled and manipulated using the `~matplotlib.artist.Artist` class. These tutorials cover the basics of the usage of Axis objects and controlling them in Matplotlib. -For even more information see the :ref: `examples page ` +For information on the `~matplotlib.artist.Artist` class, see the +:ref: `tutorial page `. + +For even more information see the :ref: `examples page `. + Some good material in artist tutorial that should be cribbed from or used here. From 9b4b6d1364e2bb1fbf49124ba1ca07f5062e5b7d Mon Sep 17 00:00:00 2001 From: Matthew Morrison Date: Tue, 18 Apr 2023 13:41:09 -0400 Subject: [PATCH 06/16] Added reference link to tutorial on artist. Fixed reference to axis artist reference page Need to move/write examples that cover using and modifying axis objects (probably in axisartist module on the examples page) --- galleries/users_explain/axis/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/galleries/users_explain/axis/index.rst b/galleries/users_explain/axis/index.rst index 1ea5c0159ff1..69df29c00ac0 100644 --- a/galleries/users_explain/axis/index.rst +++ b/galleries/users_explain/axis/index.rst @@ -10,7 +10,7 @@ of the usage of Axis objects and controlling them in Matplotlib. For information on the `~matplotlib.artist.Artist` class, see the :ref: `tutorial page `. -For even more information see the :ref: `examples page `. +For even more information see the :ref: `examples page `. From 65dcbc0aa38208990b91bf367e3515b21072bdd9 Mon Sep 17 00:00:00 2001 From: Matthew Morrison Date: Tue, 18 Apr 2023 13:42:03 -0400 Subject: [PATCH 07/16] Added reference link to tutorial on artist. Fixed reference to axis artist reference page Need to move/write examples that cover using and modifying axis objects (probably in axisartist module on the examples page) --- galleries/users_explain/axis/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/galleries/users_explain/axis/index.rst b/galleries/users_explain/axis/index.rst index 69df29c00ac0..5a9f199ee710 100644 --- a/galleries/users_explain/axis/index.rst +++ b/galleries/users_explain/axis/index.rst @@ -3,7 +3,7 @@ Controlling and labelling Axis objects -------------------------------------- -Matplotlib ``~matplotlib.axis.Axis` objects can be controlled and manipulated +Matplotlib `~matplotlib.axis.Axis` objects can be controlled and manipulated using the `~matplotlib.artist.Artist` class. These tutorials cover the basics of the usage of Axis objects and controlling them in Matplotlib. From 89b50e12c7f4ea45ea78ea83038ffe292e75826b Mon Sep 17 00:00:00 2001 From: Matthew Morrison Date: Tue, 25 Apr 2023 12:54:36 -0400 Subject: [PATCH 08/16] Capitalization issues in title for axis\index.rst Need to move/write examples that cover using and modifying axis objects (probably in axisartist module on the examples page) --- galleries/users_explain/axis/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/galleries/users_explain/axis/index.rst b/galleries/users_explain/axis/index.rst index 5a9f199ee710..3993f65693a4 100644 --- a/galleries/users_explain/axis/index.rst +++ b/galleries/users_explain/axis/index.rst @@ -1,6 +1,6 @@ .. _users_axis: -Controlling and labelling Axis objects +Controlling and Labelling Axis Objects -------------------------------------- Matplotlib `~matplotlib.axis.Axis` objects can be controlled and manipulated From a075e66eb84abe13aa35bb3ea681b49a4e87fbca Mon Sep 17 00:00:00 2001 From: Matthew Morrison Date: Tue, 25 Apr 2023 13:26:33 -0400 Subject: [PATCH 09/16] Capitalization issues in title for axis\index.rst Need to move/write examples that cover using and modifying axis objects (probably in axisartist module on the examples page) --- galleries/users_explain/axis/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/galleries/users_explain/axis/index.rst b/galleries/users_explain/axis/index.rst index 3993f65693a4..3e1111a9ce9a 100644 --- a/galleries/users_explain/axis/index.rst +++ b/galleries/users_explain/axis/index.rst @@ -3,8 +3,8 @@ Controlling and Labelling Axis Objects -------------------------------------- -Matplotlib `~matplotlib.axis.Axis` objects can be controlled and manipulated -using the `~matplotlib.artist.Artist` class. These tutorials cover the basics +Matplotlib `~.axis.Axis` objects can be controlled and manipulated +using the `~.artist.Artist` class. These tutorials cover the basics of the usage of Axis objects and controlling them in Matplotlib. For information on the `~matplotlib.artist.Artist` class, see the From 8a68f8799f8eb3df6bddfdef64c56580552e120c Mon Sep 17 00:00:00 2001 From: Matthew Morrison Date: Thu, 27 Apr 2023 13:29:18 -0400 Subject: [PATCH 10/16] Removed initial stub in index.rst Need to move/write examples that cover using and modifying axis objects (probably in axisartist module on the examples page) --- galleries/users_explain/axis/index.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/galleries/users_explain/axis/index.rst b/galleries/users_explain/axis/index.rst index 3e1111a9ce9a..9c7cae2af21c 100644 --- a/galleries/users_explain/axis/index.rst +++ b/galleries/users_explain/axis/index.rst @@ -13,5 +13,3 @@ For information on the `~matplotlib.artist.Artist` class, see the For even more information see the :ref: `examples page `. - -Some good material in artist tutorial that should be cribbed from or used here. From beb3e487ca2f8397a9cfd10cdf33e98d2f168d14 Mon Sep 17 00:00:00 2001 From: Matthew Morrison Date: Fri, 5 May 2023 22:18:32 -0400 Subject: [PATCH 11/16] Updated description that Axis is a type of Artist Added inheritance diagram to show how it is inherited Added reference to axis_api page (also added a reference within that page so it can be linked) --- doc/api/axis_api.rst | 2 ++ galleries/users_explain/axis/index.rst | 16 +++++++++++++--- 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/doc/api/axis_api.rst b/doc/api/axis_api.rst index a177f82a4a9a..27fbc966c950 100644 --- a/doc/api/axis_api.rst +++ b/doc/api/axis_api.rst @@ -1,3 +1,5 @@ +.. _axis-api: + ******************* ``matplotlib.axis`` ******************* diff --git a/galleries/users_explain/axis/index.rst b/galleries/users_explain/axis/index.rst index 9c7cae2af21c..c5e7d41d2e1b 100644 --- a/galleries/users_explain/axis/index.rst +++ b/galleries/users_explain/axis/index.rst @@ -3,9 +3,19 @@ Controlling and Labelling Axis Objects -------------------------------------- -Matplotlib `~.axis.Axis` objects can be controlled and manipulated -using the `~.artist.Artist` class. These tutorials cover the basics -of the usage of Axis objects and controlling them in Matplotlib. +Matplotlib `~.axis.Axis` objects are a type of Artist that can help +control and modify axes on a Matplotlib figure or visualization, which can +include alignment, direction, style, curve, and more. + +.. inheritance-diagram:: Tick Ticker XAxis YAxis XTick YTick + :private-bases: + +Almost every object interacted with on a Matplotlib plot is an "Artist," +which are a subclass of the `~matplotlib.artist.Artist` class. These objects +help to customize and modify your Matplotlib figures and visualizations. + +For more information on `~.axis.Axis` objects, see the +:ref: `Axis API page `. For information on the `~matplotlib.artist.Artist` class, see the :ref: `tutorial page `. From ad8d85bfc3958e5aaf8450712d5b9d9215442c29 Mon Sep 17 00:00:00 2001 From: Matthew Morrison Date: Mon, 19 Jun 2023 10:05:26 -0400 Subject: [PATCH 12/16] Modifying artists and axis description --- galleries/users_explain/axis/index.rst | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/galleries/users_explain/axis/index.rst b/galleries/users_explain/axis/index.rst index c5e7d41d2e1b..28e8456297b0 100644 --- a/galleries/users_explain/axis/index.rst +++ b/galleries/users_explain/axis/index.rst @@ -4,22 +4,20 @@ Controlling and Labelling Axis Objects -------------------------------------- Matplotlib `~.axis.Axis` objects are a type of Artist that can help -control and modify axes on a Matplotlib figure or visualization, which can +control and modify axis on a Matplotlib figure or visualization, which can include alignment, direction, style, curve, and more. .. inheritance-diagram:: Tick Ticker XAxis YAxis XTick YTick :private-bases: Almost every object interacted with on a Matplotlib plot is an "Artist," -which are a subclass of the `~matplotlib.artist.Artist` class. These objects -help to customize and modify your Matplotlib figures and visualizations. +which are a subclass of the `~matplotlib.artist.Artist` class. For more +information on the `~matplotlib.artist.Artist` class and manipulating +artists, see the :ref: `tutorial page `. For more information on `~.axis.Axis` objects, see the :ref: `Axis API page `. -For information on the `~matplotlib.artist.Artist` class, see the -:ref: `tutorial page `. - For even more information see the :ref: `examples page `. From e2739d2f3523684f5cc8f41c22c444e7883f31c1 Mon Sep 17 00:00:00 2001 From: Matthew Morrison <120498834+mattymo30@users.noreply.github.com> Date: Fri, 30 Jun 2023 13:16:39 -0400 Subject: [PATCH 13/16] Update galleries/users_explain/axis/index.rst Co-authored-by: hannah --- galleries/users_explain/axis/index.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/galleries/users_explain/axis/index.rst b/galleries/users_explain/axis/index.rst index 28e8456297b0..ba469873b906 100644 --- a/galleries/users_explain/axis/index.rst +++ b/galleries/users_explain/axis/index.rst @@ -10,9 +10,7 @@ include alignment, direction, style, curve, and more. .. inheritance-diagram:: Tick Ticker XAxis YAxis XTick YTick :private-bases: -Almost every object interacted with on a Matplotlib plot is an "Artist," -which are a subclass of the `~matplotlib.artist.Artist` class. For more -information on the `~matplotlib.artist.Artist` class and manipulating +For more information on the `~matplotlib.artist.Artist` class and manipulating artists, see the :ref: `tutorial page `. For more information on `~.axis.Axis` objects, see the From 6f434120ea14ce14333e6fa58ab93059aab7c0d0 Mon Sep 17 00:00:00 2001 From: Matthew Morrison Date: Fri, 30 Jun 2023 13:25:53 -0400 Subject: [PATCH 14/16] Redefining what the axis objects are --- galleries/users_explain/axis/index.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/galleries/users_explain/axis/index.rst b/galleries/users_explain/axis/index.rst index 28e8456297b0..427bb990a1ec 100644 --- a/galleries/users_explain/axis/index.rst +++ b/galleries/users_explain/axis/index.rst @@ -3,9 +3,12 @@ Controlling and Labelling Axis Objects -------------------------------------- -Matplotlib `~.axis.Axis` objects are a type of Artist that can help -control and modify axis on a Matplotlib figure or visualization, which can -include alignment, direction, style, curve, and more. +Matplotlib `~.axis.Axis` objects are a type of Artist that +are the underlying abstraction and the basis for the axes +on a Matplotlib figure or visualization. Axis objects are +capable of controlling and modifying axis on a figure, +which can include alignment, direction, style, curve, +and more. .. inheritance-diagram:: Tick Ticker XAxis YAxis XTick YTick :private-bases: From dace3da9fcd21eabf52236aafff536bb2817b375 Mon Sep 17 00:00:00 2001 From: Matthew Morrison <120498834+mattymo30@users.noreply.github.com> Date: Fri, 30 Jun 2023 17:10:10 -0400 Subject: [PATCH 15/16] Update galleries/users_explain/axis/index.rst Co-authored-by: hannah --- galleries/users_explain/axis/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/galleries/users_explain/axis/index.rst b/galleries/users_explain/axis/index.rst index 2cc720697730..c97df4c98906 100644 --- a/galleries/users_explain/axis/index.rst +++ b/galleries/users_explain/axis/index.rst @@ -1,6 +1,6 @@ .. _users_axis: -Controlling and Labelling Axis Objects +Controlling and labelling Axis objects -------------------------------------- Matplotlib `~.axis.Axis` objects are a type of Artist that From b99f0c06ea51b7a5edac2d0a552c58550de206c4 Mon Sep 17 00:00:00 2001 From: Matthew Morrison Date: Fri, 30 Jun 2023 17:15:04 -0400 Subject: [PATCH 16/16] Update 'axex' to 'a single axis' --- galleries/users_explain/axis/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/galleries/users_explain/axis/index.rst b/galleries/users_explain/axis/index.rst index 2cc720697730..c56e8fed5424 100644 --- a/galleries/users_explain/axis/index.rst +++ b/galleries/users_explain/axis/index.rst @@ -4,7 +4,7 @@ Controlling and Labelling Axis Objects -------------------------------------- Matplotlib `~.axis.Axis` objects are a type of Artist that -are the underlying abstraction and the basis for the axes +are the underlying abstraction and the basis for a single axis on a Matplotlib figure or visualization. Axis objects are capable of controlling and modifying axis on a figure, which can include alignment, direction, style, curve,