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

chore(tracer): remove redundant export in docs & examples #1062

Merged
merged 1 commit into from
Aug 18, 2022

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

As evidenced in this review comment, the examples, the docstrings, and the documentation had a redundant export when it comes to showing how use a Lambda handler as a class:

Before

class Lambda implements LambdaInterface {}

export const handlerClass = new Lambda();
export const handler = handlerClass.handler.bind(handlerClass);

After

class Lambda implements LambdaInterface {}

const handlerClass = new Lambda(); // <- Removes export
export const handler = handlerClass.handler.bind(handlerClass);

This PR addresses the change given that the related PR has already been merged. Similar changes have been applied to the other two PRs still open.

How to verify this change

See updated docs/examples/docstrings.

Related issues, RFCs

Issue number:#1056

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 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
  • New and existing unit tests pass locally and in Github Actions
  • The PR title follows the conventional commit semantics

Breaking change checklist

N/A


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

@dreamorosi dreamorosi added documentation Improvements or additions to documentation tracer This item relates to the Tracer Utility labels Aug 17, 2022
@dreamorosi dreamorosi self-assigned this Aug 17, 2022
@github-actions github-actions bot added the internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) label Aug 17, 2022
@dreamorosi dreamorosi merged commit 46dea7c into main Aug 18, 2022
@dreamorosi dreamorosi deleted the chore/remove_redundant_export_examples branch August 18, 2022 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) tracer This item relates to the Tracer Utility
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants