Skip to content

Commit c2f6bbf

Browse files
committed
add docstring
1 parent 1438336 commit c2f6bbf

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

.generator/cli.py

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,29 @@ def handle_configure(
121121
repo: str = REPO_DIR,
122122
input: str = INPUT_DIR,
123123
):
124+
"""Onboards a new library by completing its configuration.
125+
126+
This function reads a partial library definition from `configure-request.json`,
127+
fills in missing fields like the version, source roots, and preservation
128+
rules, and writes the complete configuration to `configure-response.json`.
129+
It ensures that new libraries conform to the repository's standard structure.
130+
131+
See https://github.com/googleapis/librarian/blob/main/doc/container-contract.md#configure-container-command
132+
133+
Args:
134+
librarian(str): Path to the directory in the container which contains
135+
the librarian configuration.
136+
source(str): Path to the directory in the container which contains
137+
API protos.
138+
repo(str): This directory will contain all directories that make up a
139+
library, the .librarian folder, and any global file declared in
140+
the config.yaml.
141+
input(str): The path to the directory in the container
142+
which contains additional generator input.
143+
144+
Raises:
145+
ValueError: If configuring a new library fails.
146+
"""
124147
# TODO(https://github.com/googleapis/librarian/issues/466): Implement configure command and update docstring.
125148
logger.info("'configure' command executed.")
126149

0 commit comments

Comments
 (0)