Skip to content

Commit f59b34c

Browse files
rakylldpasiukevich
andauthored
Fix godoc linting error by adding missing godoc (google#335)
* Fix godoc linting error by adding missing godoc Also simply the wording in some existing package godocs. * Update artifact/gcsartifact/service.go Co-authored-by: Dmitry Pasiukevich <20398573+dpasiukevich@users.noreply.github.com> --------- Co-authored-by: Dmitry Pasiukevich <20398573+dpasiukevich@users.noreply.github.com>
1 parent 437f799 commit f59b34c

File tree

30 files changed

+52
-23
lines changed

30 files changed

+52
-23
lines changed

‎agent/llmagent/doc.go‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,8 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
// Package llmagent provides a way to build LLM-based agents.
15+
// Package llmagent provides an LLM-based agent.
16+
// LLM agents use large language models to perform tasks based on instructions, user input,
17+
// deciding on actions to take, and executing actions using available tools or
18+
// delegating to sub agents.
1619
package llmagent

‎agent/remoteagent/a2a_agent.go‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
// Package remoteagent allows to use a remote agent via A2A protocol.
1615
package remoteagent
1716

1817
import (

‎agent/remoteagent/doc.go‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
// Copyright 2025 Google LLC
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
// Package remoteagent allows to use a remote ADK agents.
16+
package remoteagent

‎artifact/gcsartifact/gcs_client.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
package gcs
15+
package gcsartifact
1616

1717
import (
1818
"context"

‎artifact/gcsartifact/gcs_test.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
package gcs
15+
package gcsartifact
1616

1717
import (
1818
"bytes"

‎artifact/gcsartifact/service.go‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,12 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
// Package gcs provides a Google Cloud Storage (GCS) implementation of the
16-
// [artifact.Service] interface.
15+
// Package gcsartifact provides a Google Cloud Storage (GCS) [artifact.Service].
1716
//
1817
// This package allows storing and retrieving artifacts in a GCS bucket.
1918
// Artifacts are organized by application name, user ID, session ID, and filename,
2019
// with support for versioning.
21-
package gcs
20+
package gcsartifact
2221

2322
import (
2423
"context"

‎cmd/adkgo/adkgo.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
// Adkgo is a CLI tool to help deploy and test an ADK application.
15+
// adkgo is a CLI tool to help deploy and test an ADK application.
1616
package main
1717

1818
import (

‎cmd/launcher/console/console.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
// Package console provides a simple way to interact with an agent from console application
15+
// Package console provides a simple way to interact with an agent from console application.
1616
package console
1717

1818
import (

‎cmd/launcher/full/full.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import (
2525
"google.golang.org/adk/cmd/launcher/web/webui"
2626
)
2727

28-
// NewLauncher returnes the most versatile universal launcher with all options built-in
28+
// NewLauncher returnes the most versatile universal launcher with all options built-in.
2929
func NewLauncher() launcher.Launcher {
3030
return universal.NewLauncher(console.NewLauncher(), web.NewLauncher(api.NewLauncher(), a2a.NewLauncher(), webui.NewLauncher()))
3131
}

‎cmd/launcher/launcher.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
// Package launcher provides ways to interact with agents
15+
// Package launcher provides ways to interact with agents.
1616
package launcher
1717

1818
import (

0 commit comments

Comments
 (0)