PyCQA/docformatter

v1.7.2-rc1 - Issues with `:param xxx:` and `:return:` formatting

rmartin16 opened this issue · 3 comments

Issues from v1.7.2-rc1 on the beeware/briefcase repo.

class Example:
    def cleanup_paths(self, app):
        """Obtain the paths generated by the app template that should be cleaned up
        prior to release.

        :param app: The config object for the app
        :return: The list of path globs inside the app template that should
-            be cleaned up.
+be cleaned up.
        """
        pass
class Example:
    def _write_requirements_file(self, app, requires, requirements_path):
        """Configure application requirements by writing a requirements.txt file.

        :param app: The app configuration
        :param requires: The full list of requirements
        :param requirements_path: The full path to a requirements.txt file that
-            will be written.
+will be written.
        """
        pass
class Example:
    def build_app_context(self):
        """Ask the user for details about the app to be created.

        :returns: A context dictionary to be used in the cookiecutter project
-            template.
+template.
        """
        pass
class Example:
    def __init__(self, tools, wix_home=None, bin_install=False):
        """Create a wrapper around a WiX install.

        :param tools: ToolCache of available tools.
        :param wix_home: The path of the WiX installation.
        :param bin_install: Is the install a binaries-only install? A full
-            MSI install of WiX has a `/bin` folder in the paths; a
-            binaries-only install does not.
-        :returns: A valid WiX SDK wrapper. If WiX is not available, and was
-            not installed, raises MissingToolError.
+            MSI install of WiX has a `/bin` folder in the paths; a             binaries-
+            only install does not.
+        :returns: A valid WiX SDK wrapper. If WiX is not available, and was not
+            installed, raises MissingToolError.
        """
        pass
class Example:
    def select_identity(self, identity=None):
        """Get the codesigning identity to use.

-        :param identity: A pre-specified identity (either the 40-digit
-            hex checksum, or the string name of the identity). If provided, it
+        :param identity: A pre-specified identity (either the 40-digit             hex
+            checksum, or the string name of the identity). If provided, it
            will be validated against the list of available identities to
            confirm that it is a valid codesigning identity.
        :returns: The final identity to use
        """
        pass

@rmartin16 v1.7.2-rc2 is available and should fix these issues. Feedback is appreciated.

Resolved with v1.7.2-rc2. Thanks!

Closing this issue to #231.