Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[pkg/ottl] Add godoc comments to everything #28893

Open
Tracked by #28892
TylerHelmuth opened this issue Nov 5, 2023 · 4 comments
Open
Tracked by #28892

[pkg/ottl] Add godoc comments to everything #28893

TylerHelmuth opened this issue Nov 5, 2023 · 4 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed never stale Issues marked with this label will be never staled and automatically removed pkg/ottl priority:p2 Medium

Comments

@TylerHelmuth
Copy link
Member

TylerHelmuth commented Nov 5, 2023 •
edited
Loading

We should add godoc comments to all public interfaces in all the ottl packages
@TylerHelmuth TylerHelmuth mentioned this issue Nov 5, 2023
Open
11 tasks
@TylerHelmuth TylerHelmuth changed the title Add godoc comments to everything [pkg/ottl] Add godoc comments to everything Nov 5, 2023
@github-actions github-actions bot mentioned this issue Nov 7, 2023
Closed
@TylerHelmuth TylerHelmuth added help wanted Extra attention is needed good first issue Good for newcomers labels Dec 13, 2023
@hamzmu
Copy link
Contributor

hamzmu commented Jan 11, 2024

@TylerHelmuth is this issue still open?

@TylerHelmuth
Copy link
Member Author

Yup

@hamzmu hamzmu mentioned this issue Jan 15, 2024
Merged
TylerHelmuth added a commit that referenced this issue Feb 1, 2024
@hamzmu @evan-bradley
@crobert-1 @TylerHelmuth
[pkg/ottl]Godoc comments (#30564)
d9a5c38 
**Description:** godoc comments added to non-commented public interfaces
in [pkg/ottl] packages

**Link to tracking Issue:** #28893

**Testing:** <Describe what testing was performed and which tests were
added.>

**Documentation:** <Describe the documentation added.>

---------

Co-authored-by: Evan Bradley <11745660+evan-bradley@users.noreply.github.com>
Co-authored-by: Curtis Robert <crobert@splunk.com>
Co-authored-by: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com>
cparkins pushed a commit to AmadeusITGroup/opentelemetry-collector-contrib that referenced this issue Feb 1, 2024
@hamzmu @evan-bradley
@crobert-1 @TylerHelmuth @cparkins
[pkg/ottl]Godoc comments (open-telemetry#30564)
2f961cd 
**Description:** godoc comments added to non-commented public interfaces
in [pkg/ottl] packages

**Link to tracking Issue:** open-telemetry#28893

**Testing:** <Describe what testing was performed and which tests were
added.>

**Documentation:** <Describe the documentation added.>

---------

Co-authored-by: Evan Bradley <11745660+evan-bradley@users.noreply.github.com>
Co-authored-by: Curtis Robert <crobert@splunk.com>
Co-authored-by: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com>
@github-actions GitHub Actions
Copy link
Contributor

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

Pinging code owners:

See Adding Labels via Comments if you do not have permissions to add labels yourself.

@github-actions github-actions bot added the Stale label Mar 12, 2024
@github-actions GitHub Actions
Copy link
Contributor

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

Pinging code owners:

See Adding Labels via Comments if you do not have permissions to add labels yourself.

@github-actions github-actions bot added the Stale label May 13, 2024
@TylerHelmuth TylerHelmuth added never stale Issues marked with this label will be never staled and automatically removed and removed Stale labels May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers help wanted Extra attention is needed never stale Issues marked with this label will be never staled and automatically removed pkg/ottl priority:p2 Medium
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@evan-bradley @TylerHelmuth @hamzmu