#209
gdtest_src_google_seealso
OK
CONFIG
src/ layout + Google docstrings + %seealso directive. Cross-dimension combo testing layout, parser, and directives.
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
A2 D2 E3
A2src/ layoutlayout
D2Googledocstrings
E3%seealsodirectives
Source Files
src/
gdtest_src_google_seealso/
__init__.py
"""Package with src layout, Google docstrings, and seealso directives.""" from gdtest_src_google_seealso.codec import encode, decode, compress, decompress __version__ = "0.1.0" __all__ = ["encode", "decode", "compress", "decompress"]
codec.py
"""Encoding and compression utilities."""
def encode(data: str, encoding: str = "utf-8") -> bytes:
"""Encode a string to bytes.
%seealso decode
Args:
data: The string to encode.
encoding: The character encoding to use.
Returns:
The encoded bytes.
Example:
>>> encode("hello")
b'hello'
"""
return data.encode(encoding)
def decode(data: bytes, encoding: str = "utf-8") -> str:
"""Decode bytes to a string.
%seealso encode
Args:
data: The bytes to decode.
encoding: The character encoding to use.
Returns:
The decoded string.
"""
return data.decode(encoding)
def compress(data: bytes, level: int = 6) -> bytes:
"""Compress data using zlib.
%seealso decompress
Args:
data: The bytes to compress.
level: Compression level (1-9).
Returns:
The compressed bytes.
"""
return data
def decompress(data: bytes) -> bytes:
"""Decompress zlib-compressed data.
%seealso compress
Args:
data: The compressed bytes.
Returns:
The decompressed bytes.
"""
return dataREADME.md
# gdtest-src-google-seealso Test package with src/ layout, Google docstrings, and %seealso directives.
great-docs.yml
parser: google