← GDG /

#096 gdtest_source_title

#096 gdtest_source_title OK CONFIG
Tests source.placement: title config
Tests source.placement: 'title' (vs. default 'usage'). Source code links should appear near the title/heading of each API entry, not in the usage section. Two functions (compress, decompress).
View Site → Build Log ๐Ÿงช Test Coverage

Build Mode

● Has great-docs.yml

This package ships a pre-supplied config. The great-docs init step is skipped and great-docs build uses the spec-defined configuration directly. Tests specific config options and their rendered output.

Dimensions

K4
K4source.placement: titleconfig

Source Files

๐Ÿ“ gdtest_source_title/
๐Ÿ“„ __init__.py
"""Package testing source.placement title config."""

__version__ = "0.1.0"
__all__ = ["compress", "decompress"]


def compress(data: bytes) -> bytes:
    """
    Compress binary data.

    Parameters
    ----------
    data
        The data to compress.

    Returns
    -------
    bytes
        The compressed data.
    """
    return data


def decompress(data: bytes) -> bytes:
    """
    Decompress binary data.

    Parameters
    ----------
    data
        The data to decompress.

    Returns
    -------
    bytes
        The decompressed data.
    """
    return data
๐Ÿ“„ README.md
# gdtest-source-title

Tests source.placement: title config.
๐Ÿ“„ great-docs.yml
source:
  placement: title