How to Install and Uninstall python311-docformatter Package on openSuSE Tumbleweed

Last updated: July 05,2024

1. Install "python311-docformatter" package

This is a short guide on how to install python311-docformatter on openSuSE Tumbleweed


    
        
            $
        

        
            
                sudo zypper refresh
            
                    
    
    Copied


    
        
            $
        

        
            
                sudo zypper install
            
                        
                python311-docformatter
            
                    
    
    Copied

2. Uninstall "python311-docformatter" package

Learn how to uninstall python311-docformatter on openSuSE Tumbleweed:


    
        
            $
        

        
            
                sudo zypper remove
            
                        
                python311-docformatter
            
                    
    
    Copied

3. Information about the python311-docformatter package on openSuSE Tumbleweed

Information for package python311-docformatter:
-----------------------------------------------
Repository : openSUSE-Tumbleweed-Oss
Name : python311-docformatter
Version : 1.4-1.15
Arch : noarch
Vendor : openSUSE
Installed Size : 109.1 KiB
Installed : No
Status : not installed
Source package : python-docformatter-1.4-1.15.src
Upstream URL : https://github.com/myint/docformatter
Summary : Utility to re-format docstrings per PEP 257
Description :
Docformatter currently automatically formats docstrings to follow a
subset of the PEP 257 conventions. Below are the relevant items quoted
from PEP 257.
- For consistency, always use triple double quotes around docstrings.
- Triple quotes are used even though the string fits on one line.
- Multi-line docstrings consist of a summary line just like a one-line
docstring, followed by a blank line, followed by a more elaborate
description.
- The BDFL recommends inserting a blank line between the last paragraph
in a multi-line docstring and its closing quotes, placing the closing
quotes on a line by themselves.
docformatter also handles some of the PEP 8 conventions.
- Don't write string literals that rely on significant trailing
whitespace. Such trailing whitespace is visually indistinguishable
and some editors (or more recently, reindent.py) will trim them.