Skip to content

Add class documentation FunctionSegmentNotDefinedErrorunexpected and make end_time optional #845

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

Merged
merged 2 commits into from
May 10, 2022

Conversation

ijemmy
Copy link
Contributor

@ijemmy ijemmy commented May 10, 2022

Description of your changes

Fix @saragerion 's comments on PR #828

  1. Add class documentation on the FunctionSegmentNotDefinedErrorunexpected class
  2. Make end_time optional as it can be undefined sometimes.

How to verify this change

Run E2E test

Related issues, RFCs

N/A

PR status

Is this ready for review?: Yes
Is it a breaking change?: NO

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding changes to the examples
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published in downstream module
  • The PR title follows the conventional commit semantics

Breaking change checklist

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@ijemmy ijemmy requested review from dreamorosi and saragerion May 10, 2022 16:32
@dreamorosi dreamorosi added this to the production-ready-release milestone May 10, 2022
@dreamorosi dreamorosi added the internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) label May 10, 2022
@ijemmy
Copy link
Contributor Author

ijemmy commented May 10, 2022

E2E tests: https://github.com/awslabs/aws-lambda-powertools-typescript/actions/runs/2302043877

@dreamorosi
Copy link
Contributor

dreamorosi commented May 10, 2022

~@ijemmy I'm merging a bunch of dependabot PRs that came up after we merged the last PR. After I'm done (5 left) could you please rebase?

EDIT: not needed, discard this message

Copy link
Contributor

@saragerion saragerion left a comment

Choose a reason for hiding this comment

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

Thanks for addressing these, minor improvements but happy to merge it as it is

@@ -1,3 +1,10 @@
/**
* Thrown when the function segement (AWS::Lambda::Function) is not found in a trace.
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit

Suggested change
* Thrown when the function segement (AWS::Lambda::Function) is not found in a trace.
* Thrown when the function segment (AWS::Lambda::Function) is not found in a trace.

/**
* Thrown when the function segement (AWS::Lambda::Function) is not found in a trace.
*
* X-Ray segments are process asynchronously. They may not be available even after
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* X-Ray segments are process asynchronously. They may not be available even after
* X-Ray segments are processed asynchronously. They may not be available even after

@dreamorosi dreamorosi merged commit 018c530 into main May 10, 2022
@dreamorosi dreamorosi deleted the ijemmy/fix-comments-on-pr828 branch May 10, 2022 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants