← GDG /

#202 gdtest_display_authors

#202 gdtest_display_authors OK CONFIG
Authors with full metadata.
Authors displayed with all metadata: name, email, role, github, and a URL avatar. Sidebar should show author cards.
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

K14
K14multiple authorsconfig

Source Files

๐Ÿ“ gdtest_display_authors/
๐Ÿ“„ __init__.py
"""Package testing authors config with full metadata."""

__all__ = ["research", "publish"]


def research(topic: str) -> dict:
    """Conduct research on a given topic.

    Parameters
    ----------
    topic : str
        The research topic.

    Returns
    -------
    dict
        A dictionary with research findings.

    Examples
    --------
    >>> research("machine learning")
    {'topic': 'machine learning', 'status': 'complete'}
    """
    return {"topic": topic, "status": "complete"}


def publish(paper: dict) -> str:
    """Publish a research paper.

    Parameters
    ----------
    paper : dict
        A dictionary describing the paper to publish.

    Returns
    -------
    str
        The DOI of the published paper.

    Examples
    --------
    >>> publish({"title": "AI Research"})
    'doi:10.1234/ai-research'
    """
    return f"doi:10.1234/{paper.get('title', 'unknown').lower().replace(' ', '-')}"
๐Ÿ“„ README.md
# gdtest-display-authors

Test authors config with full metadata.
๐Ÿ“„ great-docs.yml
authors:
  - name: Dr. Jane Doe
    email: jane@university.edu
    role: Principal Investigator
    github: janedoe
  - name: John Smith
    email: john@lab.org
    role: Lead Developer
    github: jsmith