Added docstrings

This commit is contained in:
Anton Hvornum 2021-06-02 00:08:45 +02:00
parent 0901723ff4
commit 434ebb3419
1 changed files with 2 additions and 1 deletions

View File

@ -1,5 +1,6 @@
import urllib.error
import urllib.request
from typing import Union
from .general import *
from .output import log
@ -50,7 +51,7 @@ def sort_mirrorlist(raw_data :bytes, sort_order=["https", "http"]) -> bytes:
return new_raw_data
def filter_mirrors_by_region(regions, destination='/etc/pacman.d/mirrorlist', sort_order=["https", "http"], *args, **kwargs):
def filter_mirrors_by_region(regions, destination='/etc/pacman.d/mirrorlist', sort_order=["https", "http"], *args, **kwargs) -> Union[bool, bytes]:
"""
This function will change the active mirrors on the live medium by
filtering which regions are active based on `regions`.