mirror of
https://gitlab.com/dslackw/slpkg.git
synced 2024-12-26 09:58:31 +01:00
Update docstrings
This commit is contained in:
parent
340108cddb
commit
a8ac91bdcd
1 changed files with 10 additions and 14 deletions
|
@ -18,10 +18,7 @@ from slpkg.error_messages import Errors
|
|||
|
||||
|
||||
class Utilities(Configs):
|
||||
|
||||
"""
|
||||
List of utilities.
|
||||
"""
|
||||
"""List of utilities."""
|
||||
|
||||
def __init__(self):
|
||||
super(Configs, self).__init__()
|
||||
|
@ -187,9 +184,8 @@ class Utilities(Configs):
|
|||
return []
|
||||
|
||||
def count_file_size(self, name: str) -> int:
|
||||
"""
|
||||
Read the contents files from the package file list and count
|
||||
the total installation file size in bytes.
|
||||
"""Read the contents files from the package file list
|
||||
the count the total installation file size in bytes.
|
||||
Args:
|
||||
name: The name of the package.
|
||||
|
||||
|
@ -208,8 +204,8 @@ class Utilities(Configs):
|
|||
|
||||
@staticmethod
|
||||
def convert_file_sizes(byte_size: float) -> str:
|
||||
"""
|
||||
Convert bytes to kb, mb and gb.
|
||||
"""Convert bytes to kb, mb and gb.
|
||||
|
||||
Args:
|
||||
byte_size: The file size in bytes.
|
||||
Returns:
|
||||
|
@ -278,8 +274,8 @@ class Utilities(Configs):
|
|||
return packages
|
||||
|
||||
def read_json_file(self, file: Path) -> dict:
|
||||
"""
|
||||
Read JSON data from the file.
|
||||
"""Read JSON data from the file.
|
||||
|
||||
Args:
|
||||
file: Path file for reading.
|
||||
Returns:
|
||||
|
@ -295,8 +291,8 @@ class Utilities(Configs):
|
|||
return json_data
|
||||
|
||||
def ignore_packages(self, packages: list) -> list:
|
||||
"""
|
||||
Matching packages using regular expression.
|
||||
"""Matching packages using regular expression.
|
||||
|
||||
Args:
|
||||
packages: The packages to apply the pattern.
|
||||
Returns:
|
||||
|
|
Loading…
Reference in a new issue