← GDG /

#092 gdtest_config_extra_keys

#092 gdtest_config_extra_keys OK CONFIG
Config with unrecognized keys for forward compatibility
Config YAML includes unrecognized keys (custom_field, future_option) alongside valid ones. The build should succeed without errors โ€” unknown keys should be silently ignored. Key test: forward-compatible config parsing.
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

A1 B1 C1 D1 E6 F6 G1 H7
A1Flat layoutlayout
B1Explicit __all__exports
C1Functions onlyobjects
D1NumPydocstrings
E6No directivesdirectives
F6No user guideuser_guide
G1README.mdlanding
H7No extrasextras

Source Files

๐Ÿ“ gdtest_config_extra_keys/
๐Ÿ“„ __init__.py
"""Package testing forward-compatible config parsing."""

__version__ = "0.1.0"
__all__ = ["echo", "identity"]


def echo(message: str) -> str:
    """
    Echo a message back.

    Parameters
    ----------
    message
        The message to echo.

    Returns
    -------
    str
        The same message.
    """
    return message


def identity(x):
    """
    Return the input unchanged.

    Parameters
    ----------
    x
        Any value.

    Returns
    -------
    object
        The same value.
    """
    return x
๐Ÿ“„ README.md
# gdtest-config-extra-keys

Tests that unrecognized config keys are silently ignored.
๐Ÿ“„ great-docs.yml
display_name: Extra Keys Test
custom_field: this-should-be-ignored
future_option: true
nested_unknown:
  level: 2
  items:
    - a
    - b
    - c