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.

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

Ensure comments on parameters in arrow functions are captured in the docs and ci metrics. #100823

Conversation

stacey-gammon
Copy link
Contributor

Fixed #98744.

Simple fix, just needed to pass the jsdocs from the parent node into the function parsing out each child.

@stacey-gammon stacey-gammon added release_note:skip Skip the PR/issue when compiling release notes v7.14.0 v8.0.0 labels May 27, 2021
@stacey-gammon stacey-gammon requested a review from spalger May 27, 2021 20:10
Copy link
Contributor

@spalger spalger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@stacey-gammon stacey-gammon enabled auto-merge (squash) May 28, 2021 15:31
@kibanamachine
Copy link
Contributor

💚 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
charts 157 155 -2
core 1073 1061 -12
data 3264 3223 -41
embeddable 381 379 -2
expressions 1456 1444 -12
kibanaReact 218 216 -2
kibanaUtils 385 373 -12
presentationUtil 123 121 -2
total -85

History

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

@stacey-gammon stacey-gammon merged commit 8fba2d9 into elastic:master May 28, 2021
gmmorris added a commit to gmmorris/kibana that referenced this pull request May 28, 2021
* master: (77 commits)
  [RAC][Security Solution] Register Security Detection Rules with Rule Registry (elastic#96015)
  [Enterprise Search] Log warning for Kibana/EntSearch version mismatches (elastic#100809)
  updating the saved objects test to include more saved object types (elastic#100828)
  [ML] Fix categorization job view examples link when datafeed uses multiple indices (elastic#100789)
  Fixing ES archive mapping failure (elastic#100835)
  Fix bug with Observability > APM header navigation (elastic#100845)
  [Security Solution][Endpoint] Add event filters summary card to the fleet endpoint tab (elastic#100668)
  [Actions] Taking space id into account when creating email footer link (elastic#100734)
  Ensure comments on parameters in arrow functions are captured in the docs and ci metrics. (elastic#100823)
  [Security Solution] Improve find rule and find rule status route performance (elastic#99678)
  [DOCS] Adds video to introduction (elastic#100906)
  [Fleet] Improve combo box for fleet settings (elastic#100603)
  [Security Solution][Endpoint] Endpoint generator and data loader support for Host Isolation (elastic#100813)
  [DOCS] Adds Lens video (elastic#100898)
  [TSVB] [Table tab] Fix "Math" aggregation (elastic#100765)
  chore(NA): moving @kbn/io-ts-utils into bazel (elastic#100810)
  [Alerting] Adding feature flag for enabling/disabling rule import and export (elastic#100718)
  [TSVB] Fix Upgrading from 7.12.1 to 7.13.0 breaks TSVB (elastic#100864)
  [Lens] Adds dynamic table cell coloring (elastic#95217)
  [Security Solution][Endpoint] Do not display searchbar in security-trusted apps if there are no items (elastic#100853)
  ...
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Jun 1, 2021
@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 100823 or prevent reminders by adding the backport:skip label.

@stacey-gammon stacey-gammon added the auto-backport Deprecated - use backport:version if exact versions are needed label Jun 1, 2021
@kibanamachine
Copy link
Contributor

💔 Backport failed

Status Branch Result
7.x Commit could not be cherrypicked due to conflicts

To backport manually run:
node scripts/backport --pr 100823

stacey-gammon added a commit to stacey-gammon/kibana that referenced this pull request Jun 1, 2021
…docs and ci metrics. (elastic#100823)

* Make sure arrow functions capture parameter comments.

* Update docs
# Conflicts:
#	api_docs/apm.json
#	api_docs/core.json
#	api_docs/data.json
#	api_docs/data_index_patterns.json
#	api_docs/data_search.json
#	api_docs/licensing.json
#	api_docs/reporting.json
#	api_docs/spaces.json
stacey-gammon added a commit that referenced this pull request Jun 1, 2021
…docs and ci metrics. (#100823) (#101087)

* Make sure arrow functions capture parameter comments.

* Update docs
# Conflicts:
#	api_docs/apm.json
#	api_docs/core.json
#	api_docs/data.json
#	api_docs/data_index_patterns.json
#	api_docs/data_search.json
#	api_docs/licensing.json
#	api_docs/reporting.json
#	api_docs/spaces.json
@kibanamachine kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Jun 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Deprecated - use backport:version if exact versions are needed release_note:skip Skip the PR/issue when compiling release notes v7.14.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[APIDocs] const + arrow functions result in uncommented function parameters
3 participants