Commit 57c03dfe authored by BO ZHANG's avatar BO ZHANG 🏀
Browse files

fix docstring

parent 3e1b3ea1

csst_proto/config.py

+2 −1
Original line number Diff line number Diff line
@@ -25,7 +25,8 @@ HERE: str = os.path.dirname(__file__) 
# 当config_path被指定时，会读取指定的config_path

# 当config_path=None时，读取随包数据中的config/default_config.toml

def read_config(config_path: Optional[str] = None):

    """Get config info from a toml file.

    """

    Get config info from a toml file.



    Read a `toml` format config file.

    If `config_path` is specified, read that config.

csst_proto/flip_image.py

+2 −1
Original line number Diff line number Diff line
@@ -62,7 +62,8 @@ def flip_image(image: np.ndarray, use_numpy: bool = False) -> np.ndarray: 


# 此函数读取了随包数据中的test_image.txt

def read_default_image():

    """Read default image.

    """

    Read default image.



    This function reads the default image associated with this package.

csst_proto/flip_image_in_parallel.py

+4 −2
Original line number Diff line number Diff line
@@ -16,7 +16,8 @@ from .flip_image import flip_image 




def flip_multiple_images_mp(images: list[np.ndarray], n_jobs: int) -> list[np.ndarray]:

    """Flip input images in parallel.

    """

    Flip input images in parallel.



    Flip images in parallel with `multiprocessing`.
@@ -37,7 +38,8 @@ def flip_multiple_images_mp(images: list[np.ndarray], n_jobs: int) -> list[np.nd 




def flip_multiple_images_jl(images: list[np.ndarray], n_jobs: int) -> list[np.ndarray]:

    """Flip input images in parallel.

    """

    Flip input images in parallel.



    Flip images in parallel with `joblib`.