Added docstring to scatter_with_legend.py [MEP12] #6487

Merged
merged 1 commit into from May 27, 2016

Conversation

Projects
None yet
4 participants
Contributor

francoiseprovencher commented May 27, 2016

We added a docstring to the scatter_with_legend.py as part of the PyLadies meetup led by @discardthree

mdboom added the needs_review label May 27, 2016

Owner

tacaswell commented May 27, 2016

👍 will merge after CI passes

@WeatherGod WeatherGod commented on an outdated diff May 27, 2016

examples/lines_bars_and_markers/scatter_with_legend.py
@@ -1,3 +1,11 @@
+'''
+Demo of a scatter plot (scatter) with a legend.
+
+Also demonstrates how transparency of the markers
+can be adjusted by giving ``alpha`` a value between
+0 and 1.
@WeatherGod

WeatherGod May 27, 2016

Member

Can we please showcase this paragraph as an ideal example of an example docstring? Clear and concise, and highlighted exactly what this example demonstrates!

Owner

tacaswell commented May 27, 2016

We test on pep8 conformance of the source and examples. It looks like there are some trailing whitespaces left. This is something you can configure your editor to automatically remove on save.

FAIL: matplotlib.tests.test_coding_standards.test_pep8_conformance_examples
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/travis/build/matplotlib/matplotlib/venv/lib/python3.5/site-packages/nose/case.py", line 198, in runTest
    self.test(*self.arg)
  File "/home/travis/build/matplotlib/matplotlib/lib/matplotlib/tests/test_coding_standards.py", line 277, in test_pep8_conformance_examples
    expected_bad_files=expected_bad_files)
  File "/home/travis/build/matplotlib/matplotlib/lib/matplotlib/tests/test_coding_standards.py", line 143, in assert_pep8_conformance
    assert_equal(result.total_errors, 0, msg)
AssertionError: 3 != 0 : Found code syntax errors (and warnings):
/home/travis/build/matplotlib/matplotlib/examples/lines_bars_and_markers/scatter_with_legend.py:2:48: W291 trailing whitespace
/home/travis/build/matplotlib/matplotlib/examples/lines_bars_and_markers/scatter_with_legend.py:4:50: W291 trailing whitespace
/home/travis/build/matplotlib/matplotlib/examples/lines_bars_and_markers/scatter_with_legend.py:5:52: W291 trailing whitespace
----------------------------------------------------------------------

tacaswell added this to the 2.1 (next point release) milestone May 27, 2016

@francoiseprovencher francoiseprovencher Added docstring to scatter_with_legend.py [MEP12]
d922945
Contributor

francoiseprovencher commented May 27, 2016

@tacaswell I amended the original commit to remove the trailing whitespaces, should be PEP8 compliant now.

Member

WeatherGod commented May 27, 2016

appveyor failure is unrelated (conda server unavailable)

@WeatherGod WeatherGod merged commit 77c23f8 into matplotlib:master May 27, 2016

2 of 3 checks passed

continuous-integration/appveyor/pr AppVeyor build failed
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage remained the same at 69.773%
Details

mdboom removed the needs_review label May 27, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment