From 67df4bb1305b6cf544ad5ff96d930d1b943ce80a Mon Sep 17 00:00:00 2001 From: Karl Knechtel Date: Fri, 26 Jul 2024 15:23:16 -0400 Subject: [PATCH] Remove docstrings On second thought, there's no real point to documenting these hooks. What they do is already documented by the PEP 517 standard, and this code isn't meant to be used directly anyway (only invoked by a build frontend, which won't care about the documentation). Therefore, such documentation is only potentially wasting space. --- src/bbbb/__init__.py | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/src/bbbb/__init__.py b/src/bbbb/__init__.py index 4a24982..f7ddc67 100644 --- a/src/bbbb/__init__.py +++ b/src/bbbb/__init__.py @@ -19,12 +19,6 @@ def _exclude_hidden_and_special_files(archive_entry): def build_sdist(sdist_directory, config_settings): - """Create an sdist (implements hook defined in PEP 517). - - sdist_directory -> where the sdist (.tar.gz archive) will be placed. - config_settings -> info from pyproject.toml, provided by the frontend. - - Returns the name of the created file.""" # Make an sdist and return both the Python object and its filename name = f"{NAME}-{VERSION}.tar.gz" sdist_path = Path(sdist_directory) / name @@ -40,14 +34,6 @@ def build_sdist(sdist_directory, config_settings): def build_wheel( wheel_directory, metadata_directory=None, config_settings=None ): - """Create a wheel (implements hook defined in PEP 517). - - wheel_directory -> where the wheel (zip archive) will be placed. - metadata_directory -> ignored. - (`prepare_metadata_for_build_wheel` not implemented.) - config_settings -> info from pyproject.oml, provided by the frontend. - - Returns the name of the created file.""" wheel_name = f"{NAME}-{VERSION}-{PYTHON_TAG}-{ABI_TAG}-{PLATFORM_TAG}.whl" wheel_path = Path(wheel_directory) / wheel_name # Assume src layout and that metadata has already been created therein.