Skip to content

Fix doc warning #13743

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.

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 24, 2019
Merged

Fix doc warning #13743

merged 1 commit into from
Mar 24, 2019

Conversation

timhoffm
Copy link
Member

@timhoffm timhoffm commented Mar 23, 2019

PR Summary

This fixes two documentation warnings. See comments to the code.

@@ -414,6 +414,7 @@
:scale: 50

xkcd

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixes

/home/circleci/project/doc/tutorials/introductory/sample_plots.rst:425: WARNING: Explicit markup ends without a blank line; unexpected unindent.

which was caused by the original code translating to .rst as:

.. figure:: ../../gallery/showcase/images/sphx_glr_xkcd_001.png
   :target: ../../gallery/showcase/xkcd.html
   :align: center
   :scale: 50

   xkcd
Subplot example
===============

@@ -12,7 +12,7 @@
x = np.linspace(0.1, 2 * np.pi, 41)
y = np.exp(np.sin(x))

plt.stem(x, y)
plt.stem(x, y, use_line_collection=True)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needed to prevent warning

/home/circleci/project/examples/lines_bars_and_markers/stem_plot.py:15: UserWarning: In Matplotlib 3.3 individual lines on a stem plot will be added as a LineCollection instead of individual lines. This significantly improves the performance of a stem plot. To remove this warning and switch to the new behaviour, set the "use_line_collection" keyword argument to True.

@timhoffm
Copy link
Member Author

Waiting for #13745 to fix doc build.

@timhoffm timhoffm mentioned this pull request Mar 24, 2019
6 tasks
@timhoffm
Copy link
Member Author

timhoffm commented Mar 24, 2019

Rebased. Hopefully doc build is running again correctly now.

Pointing to 3.1 as every doc build of 3.1 and above is affected.

@timhoffm timhoffm added this to the v3.1.0 milestone Mar 24, 2019
@timhoffm
Copy link
Member Author

Hm, the sample_plots.rst:425 warning is still present. Do I have to edit a file other than sample_plots.py, or is there maybe a build cache for the docs that did not pick up this change?

@timhoffm timhoffm closed this Mar 24, 2019
@timhoffm timhoffm reopened this Mar 24, 2019
@timhoffm
Copy link
Member Author

timhoffm commented Mar 24, 2019

Trying powercycling to rerun the docs.

Edit: Unfortunately this did not trigger CircleCI.

If nobody has an idea how to rerun CircleCI, I propose to merge and see if this is solved when creating future PRs. After all, adding a blank line cannot break too much 😄 .

@jklymak jklymak added Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. labels Mar 24, 2019
@jklymak jklymak merged commit b8ec77c into matplotlib:master Mar 24, 2019
@jklymak
Copy link
Member

jklymak commented Mar 24, 2019

Merged as just a documentation change...

meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Mar 24, 2019
jklymak added a commit that referenced this pull request Mar 24, 2019
…743-on-v3.1.x

Backport PR #13743 on branch v3.1.x (Fix doc warning)
@timhoffm timhoffm deleted the fix-doc-warning branch March 24, 2019 21:11
@anntzer anntzer mentioned this pull request Mar 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants