← GDG /

#116 gdtest_config_combo_a

#116 gdtest_config_combo_a OK CONFIG
Config combo: display_name, authors, funding, github_style=icon, source.placement=title. Tests cosmetic and metadata options together.
Combination: display_name + authors + funding + github_icon + source.placement=title. All these config options together should not conflict. Site title ≠ package name.
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

K1 K4 K12 K13 K14
K1github_style: iconconfig
K4source.placement: titleconfig
K12display_name overrideconfig
K13funding configconfig
K14multiple authorsconfig

Source Files

📁 gdtest_config_combo_a/
📄 __init__.py
"""Combo A Toolkit."""
📄 core.py
"""CRUD operations for items."""


def create(name: str) -> dict:
    """Create a new item with the given name.

    Parameters
    ----------
    name : str
        The name for the new item.

    Returns
    -------
    dict
        The newly created item as a dictionary with 'name' and 'id' keys.

    Examples
    --------
    >>> create("widget")
    {'name': 'widget', 'id': 1}
    """
    return {"name": name, "id": 1}


def update(item: dict) -> dict:
    """Update an existing item.

    Parameters
    ----------
    item : dict
        The item to update. Must contain an 'id' key.

    Returns
    -------
    dict
        The updated item dictionary.

    Examples
    --------
    >>> update({"id": 1, "name": "updated_widget"})
    {'id': 1, 'name': 'updated_widget'}
    """
    return item


def delete(item_id: str) -> bool:
    """Delete an item by its ID.

    Parameters
    ----------
    item_id : str
        The unique identifier of the item to delete.

    Returns
    -------
    bool
        True if the item was successfully deleted, False otherwise.

    Examples
    --------
    >>> delete("abc123")
    True
    """
    return True
📄 great-docs.yml
display_name: Combo A Toolkit
authors:
  - name: Alice Smith
    url: "https://example.com/alice"
  - name: Bob Jones
    url: "https://example.com/bob"
funding:
  text: Supported by Example Foundation
  url: "https://example.com/funding"
github_style: icon
source:
  enabled: true
  placement: title