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

[EBT][chore] Reduce APIs missing comments #132866

Merged
merged 1 commit into from
May 25, 2022
Merged

[EBT][chore] Reduce APIs missing comments #132866

merged 1 commit into from
May 25, 2022

Conversation

afharo
Copy link
Member

@afharo afharo commented May 25, 2022

Summary

Small PR adding documentation to all the APIs that were missing comments in the EBT packages.

Checklist

  • Documentation was added for features that require explanation or tutorials

For maintainers

@afharo afharo added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting v8.4.0 labels May 25, 2022
@afharo afharo force-pushed the chore/reduce-apis-missing-comments branch from 2c6ad66 to c30dd2e Compare May 25, 2022 06:59
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
@kbn/analytics-client 7 0 -7
@kbn/analytics-shippers-elastic-v3-browser 13 0 -13
@kbn/analytics-shippers-elastic-v3-common 13 0 -13
@kbn/analytics-shippers-elastic-v3-server 13 0 -13
@kbn/analytics-shippers-fullstory 4 0 -4
total -50
Unknown metric groups

API count

id before after diff
@kbn/analytics-shippers-elastic-v3-common 22 23 +1

History

  • 💚 Build #47457 succeeded 2c6ad66dd804cc08db8f4813e06d1a672c8cfbb6

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@afharo afharo marked this pull request as ready for review May 25, 2022 10:24
@afharo afharo requested a review from a team as a code owner May 25, 2022 10:24
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-core (Team:Core)

@afharo afharo added the chore label May 25, 2022
@afharo afharo merged commit d6c222c into elastic:main May 25, 2022
@afharo afharo deleted the chore/reduce-apis-missing-comments branch May 25, 2022 16:59
@jsanz jsanz mentioned this pull request May 26, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pgayvallet pgayvallet pgayvallet approved these changes

Assignees
No one assigned
Labels
backport:skip This commit does not require backporting chore release_note:skip Skip the PR/issue when compiling release notes Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v8.4.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@afharo @kibana-ci @elasticmachine @pgayvallet