#091
gdtest_config_parser
OK
CONFIG
Config overrides parser to google
Config overrides parser to 'google' even though docstrings are written in Google style (matching). On the Reference page, Google Args/Returns should parse correctly with the explicit parser setting.
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 E3 F2 G1 H7
A1Flat layoutlayout
B1Explicit __all__exports
C1Functions onlyobjects
D1NumPydocstrings
E3%seealsodirectives
F2Frontmatter sectionsuser_guide
G1README.mdlanding
H7No extrasextras
Source Files
gdtest_config_parser/
__init__.py
"""
Package with Google docstrings and parser config override.
"""
__version__ = "0.1.0"
__all__ = ["connect", "disconnect", "query", "fetch_all"]
def connect(host: str, port: int = 5432) -> object:
"""Connect to a database.
Args:
host: Database hostname.
port: Port number.
Returns:
Connection object.
"""
return {"host": host, "port": port, "connected": True}
def disconnect(conn: object) -> None:
"""Disconnect from the database.
Args:
conn: Active connection.
"""
pass
def query(conn: object, sql: str) -> list:
"""Execute a SQL query.
Args:
conn: Active connection.
sql: SQL query string.
Returns:
List of result rows.
"""
return []
def fetch_all(conn: object, table: str) -> list:
"""Fetch all rows from a table.
Args:
conn: Active connection.
table: Table name.
Returns:
All rows from the table.
"""
return []README.md
# gdtest-config-parser Tests explicit parser='google' config override.
great-docs.yml
parser: google