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

Document public interfaces with versioning policy #3673

Closed
MrAlias opened this issue Feb 3, 2023 · 2 comments · Fixed by #4396
Closed

Document public interfaces with versioning policy #3673

MrAlias opened this issue Feb 3, 2023 · 2 comments · Fixed by #4396
Assignees
@MrAlias
Milestone
v1.18.0/v0.41.0

Comments

@MrAlias
Copy link
Contributor

MrAlias commented Feb 3, 2023

Similar to #2012, add documentation to exported interfaces.
@wisdommatt
Copy link
Contributor

@MrAlias I would like to work on this

@MrAlias
Copy link
Contributor Author

MrAlias commented Jun 1, 2023

This might be in the wrong project, and it might be done. Verification needed.

@MrAlias MrAlias self-assigned this Jun 1, 2023
MrAlias added a commit to MrAlias/opentelemetry-go that referenced this issue Jul 31, 2023
@MrAlias
Document public ifaces to remain stable
b31412a 
Resolve open-telemetry#3673
MrAlias added a commit to MrAlias/opentelemetry-go that referenced this issue Jul 31, 2023
@MrAlias
Document public ifaces to remain stable
41388ac 
Resolve open-telemetry#3673
@MrAlias MrAlias mentioned this issue Jul 31, 2023
Merged
MrAlias added a commit that referenced this issue Sep 6, 2023
@MrAlias @hanyuancheung @pellared
Document public metric SDK interfaces to remain stable (#4396)
76c370f 
* Document public ifaces to remain stable

Resolve #3673

* Revert changes to aggregation pkg

* Document reader as an interface that can be extended

* Address feedback

---------

Co-authored-by: Chester Cheung <cheung.zhy.csu@gmail.com>
Co-authored-by: Robert Pająk <pellared@hotmail.com>
@MrAlias MrAlias added this to the v1.18.0/v0.41.0 milestone Sep 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MrAlias MrAlias

Labels
None yet
Projects
No open projects
Go: Metric SDK (GA)
Status: Done
Milestone
v1.18.0/v0.41.0
Development

Successfully merging a pull request may close this issue.

Document public metric SDK interfaces to remain stable MrAlias/opentelemetry-go
2 participants
@MrAlias @wisdommatt