googleapis / googleapis/librarian

sidekick: remove redundant explicit links

Open
#3,744 3 comments 0 reactions 0 assignees View on GitHub
sidekick
Dominant language
Go
Stars
45
Forks
61
Avg merge
18h 32m
Merged PRs (30d)
175

Description

Sometimes the comments have links that point to the same thing, as in:

```
// Say something deep about [Foo][google.cloud.foo.v1.Foo]
message Foo
```

That ends up emitting code that references the same thing:

```
/// Say something deep about [Foo][google.cloud.foo.v1.Foo]
///
/// [google.cloud.foo.v1.Foo]: crate::model::Foo
struct Foo ...
```

The generated code could be simpler, just:

```
/// Say something deep about [Foo]
struct Foo ...
```

Contributor guide

Open the contributing guide

Research direction

The issue names no files, tests, or entry points. Locate the Go code that generates documentation comments and resolves explicit links, then reproduce the shown example; done means redundant links are omitted while non-redundant links remain intact.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.