From 10f27fc12ad29a25888c46b9d67ecf5744b93b39 Mon Sep 17 00:00:00 2001 From: Roman Yurchak Date: Sun, 3 Nov 2019 19:09:53 +0100 Subject: [PATCH] Minor style improvements to doc/example.py to pass validation --- doc/example.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/doc/example.py b/doc/example.py index 4ff07c8f..c051d4f2 100644 --- a/doc/example.py +++ b/doc/example.py @@ -35,8 +35,7 @@ def foo(var1, var2, long_var_name='hi'): - r"""A one-line summary that does not use variable names or the - function name. + r"""A one-line summary that does not use variable names. Several sentences providing an extended description. Refer to variables using back-ticks, e.g. `var`. @@ -78,7 +77,7 @@ def foo(var1, var2, long_var_name='hi'): See Also -------- - numpy.array : relationship (optional) + numpy.array : Relationship (optional). numpy.ndarray : Relationship (optional), which could be fairly long, in which case the line wraps here. numpy.dot, numpy.linalg.norm, numpy.eye @@ -117,7 +116,6 @@ def foo(var1, var2, long_var_name='hi'): >>> print("a\nb") a b - """ # After closing class docstring, there should be one blank line to # separate following codes (according to PEP257).