Skip to content

Add one-line descriptions to remaining examples #8921

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

Jump to bottom
Closed
choldgraf opened this issue Jul 21, 2017 · 13 comments
Closed

Add one-line descriptions to remaining examples #8921

choldgraf opened this issue Jul 21, 2017 · 13 comments
Labels
Difficulty: Easy https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues Documentation Good first issue Open a pull request against these issues if there are no active ones!

Comments

@choldgraf
Copy link
Contributor

Many examples don't have one-line descriptions underneath the title. We should add these in for consistency / readability / sphinx-gallery goodness. Here's a list of files to looks for:

examples/axes_grid1/demo_axes_divider.py
examples/axes_grid1/demo_axes_grid.py
examples/axes_grid1/demo_axes_grid2.py
examples/axes_grid1/demo_axes_hbox_divider.py
examples/axes_grid1/demo_axes_rgb.py
examples/axes_grid1/demo_colorbar_of_inset_axes.py
examples/axes_grid1/demo_colorbar_with_axes_divider.py
examples/axes_grid1/demo_colorbar_with_inset_locator.py
examples/axes_grid1/demo_edge_colorbar.py
examples/axes_grid1/demo_fixed_size_axes.py
examples/axes_grid1/demo_imagegrid_aspect.py
examples/axes_grid1/demo_new_colorbar.py
examples/axes_grid1/inset_locator_demo.py
examples/axes_grid1/inset_locator_demo2.py
examples/axes_grid1/make_room_for_ylabel_using_axesgrid.py
examples/axes_grid1/parasite_simple.py
examples/axes_grid1/parasite_simple2.py
examples/axes_grid1/scatter_hist.py
examples/axes_grid1/simple_anchored_artists.py
examples/axes_grid1/simple_axes_divider1.py
examples/axes_grid1/simple_axes_divider2.py
examples/axes_grid1/simple_axes_divider3.py
examples/axes_grid1/simple_axesgrid.py
examples/axes_grid1/simple_axesgrid2.py
examples/axes_grid1/simple_axisline4.py
examples/axes_grid1/simple_colorbar.py
examples/axes_grid1/simple_rgb.py
examples/event_handling/close_event.py
examples/event_handling/data_browser.py
examples/event_handling/looking_glass.py
examples/event_handling/path_editor.py
examples/images_contours_and_fields/griddata_demo.py
examples/images_contours_and_fields/shading_example.py
examples/lines_bars_and_markers/scatter_custom_symbol.py
examples/lines_bars_and_markers/scatter_hist.py
examples/lines_bars_and_markers/scatter_masked.py
examples/lines_bars_and_markers/scatter_profile.py
examples/lines_bars_and_markers/scatter_star_poly.py
examples/lines_bars_and_markers/scatter_symbol.py
examples/misc/rasterization_demo.py
examples/misc/rec_groupby_demo.py
examples/misc/tight_bbox_test.py
examples/pylab_examples/anchored_artists.py
examples/pylab_examples/anscombe.py
examples/pylab_examples/arctest.py
examples/pylab_examples/arrow_simple_demo.py
examples/pylab_examples/aspect_loglog.py
examples/pylab_examples/axes_zoom_effect.py
examples/pylab_examples/barcode_demo.py
examples/pylab_examples/dashpointlabel.py
examples/pylab_examples/date_demo_convert.py
examples/pylab_examples/demo_agg_filter.py
examples/pylab_examples/demo_annotation_box.py
examples/pylab_examples/demo_bboximage.py
examples/pylab_examples/demo_ribbon_box.py
examples/pylab_examples/demo_text_path.py
examples/pylab_examples/demo_text_rotation_mode.py
examples/pylab_examples/demo_tight_layout.py
examples/pylab_examples/ellipse_collection.py
examples/pylab_examples/ellipse_demo.py
examples/pylab_examples/ellipse_rotated.py
examples/pylab_examples/fancyarrow_demo.py
examples/pylab_examples/fancytextbox_demo.py
examples/pylab_examples/fill_spiral.py
examples/pylab_examples/gradient_bar.py
examples/pylab_examples/interp_demo.py
examples/pylab_examples/load_converter.py
examples/pylab_examples/log_bar.py
examples/pylab_examples/marker_path.py
examples/pylab_examples/movie_demo_sgskip.py
examples/pylab_examples/multiline.py
examples/pylab_examples/multiple_yaxis_with_spines.py
examples/pylab_examples/patheffect_demo.py
examples/pylab_examples/system_monitor.py
examples/pyplots/align_ylabels.py
examples/pyplots/annotate_transform.py
examples/pyplots/annotation_basic.py
examples/pyplots/annotation_polar.py
examples/pyplots/auto_subplots_adjust.py
examples/pyplots/compound_path_demo.py
examples/pyplots/dollar_ticks.py
examples/pyplots/fig_axes_customize_simple.py
examples/pyplots/fig_axes_labels_simple.py
examples/pyplots/fig_x.py
examples/pyplots/pyplot_annotate.py
examples/pyplots/pyplot_formatstr.py
examples/pyplots/pyplot_mathtext.py
examples/pyplots/pyplot_scales.py
examples/pyplots/pyplot_simple.py
examples/pyplots/pyplot_text.py
examples/pyplots/pyplot_three.py
examples/pyplots/pyplot_two_subplots.py
examples/pyplots/text_layout.py
examples/pyplots/whats_new_1_subplot3d.py
examples/pyplots/whats_new_98_4_fancy.py
examples/pyplots/whats_new_98_4_fill_between.py
examples/pyplots/whats_new_98_4_legend.py
examples/pyplots/whats_new_99_axes_grid.py
examples/pyplots/whats_new_99_mplot3d.py
examples/pyplots/whats_new_99_spines.py
examples/subplots_axes_and_figures/subplot_toolbar.py
examples/subplots_axes_and_figures/subplots_adjust.py
examples/text_labels_and_annotations/stix_fonts_demo.py
examples/text_labels_and_annotations/usetex_baseline_test.py
examples/text_labels_and_annotations/usetex_demo.py
examples/units/basic_units.py
examples/user_interfaces/embedding_in_qt4_wtoolbar_sgskip.py
examples/user_interfaces/embedding_in_tk2_sgskip.py
examples/user_interfaces/embedding_in_tk_sgskip.py
examples/user_interfaces/fourier_demo_wx_sgskip.py
examples/user_interfaces/lineprops_dialog_gtk_sgskip.py
examples/user_interfaces/mpl_with_glade_316_sgskip.py
examples/user_interfaces/mpl_with_glade_sgskip.py
examples/userdemo/anchored_box01.py
examples/userdemo/anchored_box02.py
examples/userdemo/anchored_box03.py
examples/userdemo/anchored_box04.py
examples/userdemo/annotate_explain.py
examples/userdemo/annotate_simple01.py
examples/userdemo/annotate_simple02.py
examples/userdemo/annotate_simple03.py
examples/userdemo/annotate_simple04.py
examples/userdemo/annotate_simple_coord01.py
examples/userdemo/annotate_simple_coord02.py
examples/userdemo/annotate_simple_coord03.py
examples/userdemo/annotate_text_arrow.py
examples/userdemo/axis_direction_demo_step01.py
examples/userdemo/axis_direction_demo_step02.py
examples/userdemo/axis_direction_demo_step03.py
examples/userdemo/axis_direction_demo_step04.py
examples/userdemo/connect_simple01.py
examples/userdemo/connectionstyle_demo.py
examples/userdemo/custom_boxstyle01.py
examples/userdemo/custom_boxstyle02.py
examples/userdemo/demo_axis_direction.py
examples/userdemo/demo_gridspec01.py
examples/userdemo/demo_gridspec02.py
examples/userdemo/demo_gridspec03.py
examples/userdemo/demo_gridspec04.py
examples/userdemo/demo_gridspec05.py
examples/userdemo/demo_gridspec06.py
examples/userdemo/demo_parasite_axes_sgskip.py
examples/userdemo/demo_ticklabel_alignment.py
examples/userdemo/demo_ticklabel_direction.py
examples/userdemo/pgf_fonts_sgskip.py
examples/userdemo/pgf_preamble_sgskip.py
examples/userdemo/pgf_texsystem_sgskip.py
examples/userdemo/simple_annotate01.py
examples/userdemo/simple_axis_direction01.py
examples/userdemo/simple_axis_direction03.py
examples/userdemo/simple_axis_pad.py
examples/userdemo/simple_axisartist1.py
examples/userdemo/simple_axisline.py
examples/userdemo/simple_axisline2.py
examples/userdemo/simple_axisline3.py
examples/userdemo/simple_legend01.py
examples/userdemo/simple_legend02.py
examples/widgets/buttons.py
examples/widgets/check_buttons.py
examples/widgets/cursor.py
examples/widgets/lasso_selector_demo_sgskip.py
examples/widgets/menu.py
examples/widgets/multicursor.py
examples/widgets/radio_buttons.py
examples/widgets/slider_demo.py
examples/widgets/textbox.py
@choldgraf choldgraf added Difficulty: Easy https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues Documentation labels Jul 21, 2017
@QuLogic QuLogic added this to the 2.1 (next point release) milestone Jul 22, 2017
@tacaswell
Copy link
Member

@choldgraf how did you generate this list? Is it easy to re-generate it?

@choldgraf
Copy link
Contributor Author

I believe it was pulled from another PR :-/ I didn't generate it

@tacaswell tacaswell modified the milestones: 2.1 (next point release), 2.1.1 (next bug fix release) Sep 24, 2017
@divyam3897
Copy link
Contributor

Can it be split in multiple PRs (seeing the number of files :D) ? Does it just require a one liner about the example in the end?

@tacaswell
Copy link
Member

@divyam3897 Yes, splitting into has many PRs as is required is fine.

I one sentence description is the minimum, a longer description would be better! I think updates to clarify the examples would also be OK to include.

@tacaswell tacaswell modified the milestones: 2.1.1 (next bug fix release), 2.2 (next feature release) Oct 9, 2017
@divyam3897 divyam3897 mentioned this issue Oct 9, 2017
Merged
5 tasks
@divyam3897
Copy link
Contributor

@tacaswell I made a PR for the first set of examples starting from event description. Can you review them and suggest changes if any required? :)

@choldgraf
Copy link
Contributor Author

can you link to the PR? :-)

@divyam3897
Copy link
Contributor

@choldgraf sure #9333 :)

@divyam3897 divyam3897 mentioned this issue Oct 10, 2017
Merged
5 tasks
@divyam3897
Copy link
Contributor

@choldgraf @tacaswell second PR to the list #9341 for images-contours_and_fields

@divyam3897 divyam3897 mentioned this issue Oct 13, 2017
Merged
@divyam3897
Copy link
Contributor

@choldgraf @tacaswell third one #9392 for subplots_axis_and_figures.
Some things to ask:

  1. Where are the examples of pyplot on the website here http://matplotlib.org/1.4.3/examples/ ?
  2. I couldn't find the pylab_examples in examples/

@dstansby
Copy link
Member

I'm not sure about number 1. (that link is to old docs though, so maybe try matplotlib.org ?), but for number 2. all the pylab_examples got moved to more relevant folders. The titles didn't change though so it shouldn't be too hard to find them.

@tacaswell tacaswell added the Good first issue Open a pull request against these issues if there are no active ones! label Oct 16, 2017
@divyam3897 divyam3897 mentioned this issue Oct 16, 2017
Merged
@ash13
Copy link
Contributor

ash13 commented Oct 19, 2017

Hi, I want to work on this. How do I go about it? Could someone help me with it?

@ash13 ash13 mentioned this issue Oct 19, 2017
Merged
6 tasks
@ash13
Copy link
Contributor

ash13 commented Oct 19, 2017

Hi, I tried doing the fixes. Please do let me know if this works:
#9478

@pdubcali pdubcali mentioned this issue Mar 15, 2018
Merged
6 tasks
daguito81 added a commit to daguito81/matplotlib that referenced this issue Mar 28, 2019
@daguito81
fixed bug in matplotlib#13778, created description matplotlib#8921
cf7ba1a
@daguito81 daguito81 mentioned this issue Mar 28, 2019
Closed
5 tasks
This was referenced Jun 20, 2020
Closed
Merged
@timhoffm
Copy link
Member

IMHO it's more important to consolidate the number of examples. This holds particular for the "small" examples that don't have descriptions. Adding an one-line description can still be done on a case-by-case basis. I don't think we need an open issue to track this. The above list is outdated anyway.

@story645 story645 removed this from the future releases milestone Oct 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Difficulty: Easy https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues Documentation Good first issue Open a pull request against these issues if there are no active ones!
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
8 participants
@tacaswell @QuLogic @story645 @choldgraf @timhoffm @ash13 @dstansby @divyam3897