Skip to content

Commit

Permalink
Remove docstrings
Browse files Browse the repository at this point in the history
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.
zahlman committed Jul 26, 2024
1 parent 620022b commit 67df4bb
Showing 1 changed file with 0 additions and 14 deletions.
14 changes: 0 additions & 14 deletions src/bbbb/__init__.py
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 67df4bb

Please sign in to comment.