Skip to content

Commit 797fca9

Browse files
belaltaher8Copilot
andcommitted
docs: describe the metadata-less ToolDefinition overload by its steady state
Reword the 7-arg constructor's Javadoc to describe what the overload is (a convenience constructor equivalent to the canonical one with metadata=null) rather than its relationship to a specific change ("backward-compatible", "retained so ... keep compiling after metadata was added"), which is only meaningful in the context of the PR that introduced it. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: bf2bf0dd-ec9f-42f5-a6e1-4f2a9e562d5f
1 parent 9806296 commit 797fca9

1 file changed

Lines changed: 3 additions & 5 deletions

File tree

java/src/main/java/com/github/copilot/rpc/ToolDefinition.java

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,12 +90,10 @@ public record ToolDefinition(@JsonProperty("name") String name, @JsonProperty("d
9090
@JsonProperty("metadata") Map<String, Object> metadata) {
9191

9292
/**
93-
* Backward-compatible constructor without the {@code metadata} component.
93+
* Creates a tool definition without a {@code metadata} bag.
9494
* <p>
95-
* Delegates to the canonical constructor with {@code metadata} set to
96-
* {@code null}. Retained so existing direct constructor call sites (including
97-
* previously-generated {@code $$CopilotToolMeta} classes) keep compiling after
98-
* {@code metadata} was added.
95+
* Convenience overload equivalent to the canonical constructor with
96+
* {@code metadata} set to {@code null}.
9997
*
10098
* @param name
10199
* the unique name of the tool

0 commit comments

Comments
 (0)