-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
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
Fix doc warning #13743
Conversation
3190cf1
to
3c25c56
Compare
@@ -414,6 +414,7 @@ | |||
:scale: 50 | |||
|
|||
xkcd | |||
|
There was a problem hiding this comment.
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
===============
3c25c56
to
3e45fe3
Compare
@@ -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) |
There was a problem hiding this comment.
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.
Waiting for #13745 to fix doc build. |
3e45fe3
to
afd76e6
Compare
Rebased. Hopefully doc build is running again correctly now. Pointing to 3.1 as every doc build of 3.1 and above is affected. |
Hm, the |
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 😄 . |
Merged as just a documentation change... |
…743-on-v3.1.x Backport PR #13743 on branch v3.1.x (Fix doc warning)
PR Summary
This fixes two documentation warnings. See comments to the code.