pycodestyle formatting in sage_docbuild

[fchapoton]

mainly cosmetic details

also convert some "Returns" to "Return"

Component: doctest framework

Author: Frédéric Chapoton

Branch/Commit: 1040829

Reviewer: David Coudert

Issue created by migration from https://trac.sagemath.org/ticket/33301

[fchapoton]

New commits:

c3f02f4

pycodestyle formatting in sage_docbuild

[fchapoton]

Branch: u/chapoton/33301

[fchapoton]

Commit: c3f02f4

[dcoudert]

comment:2

in src/sage_docbuild/__init__.py (aren't we on the way to remove __init__.py files ?) there are several places where you have not separated the first docstring and the rest of the paragraph, e.g.

 def get_builder(name):
     """
-    Returns an appropriate *Builder object for the document ``name``.
+    Return an appropriate *Builder object for the document ``name``.
     DocBuilder and its subclasses do all the real work in building the
     documentation.

     def get_all_documents(self):
         """
-        Returns a list of all of the documents. A document is a directory within one of
+        Return a list of all of the documents. A document is a directory within one of
         the language subdirectories of SAGE_DOC_SRC specified by the global LANGUAGES
         variable.

[sagetrac-git]

Changed commit from c3f02f4 to 1040829

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

1040829

more details in docbuild __init__

[fchapoton]

comment:4

Voilà qui est fait.

[mkoeppe]

comment:5

Replying to @dcoudert:

aren't we on the way to remove __init__.py files ?

Not all of them, only for namespace packages - https://doc.sagemath.org/html/en/developer/packaging_sage_library.html#ordinary-packages-vs-implicit-namespace-packages

[dcoudert]

comment:6

Unless I'm mistaken, the error reported by the patchbot has nothing to do with the changes done in this ticket.

LGTM.

[dcoudert]

Reviewer: David Coudert

[vbraun]

Changed branch from u/chapoton/33301 to 1040829