Skip to content

chore(docs): Tracer docs #274

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 7 commits into from
Dec 15, 2021
Merged

chore(docs): Tracer docs #274

merged 7 commits into from
Dec 15, 2021

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

Created documentation for Tracer according to current implementation in #107.

How to verify this change

Checkout branch locally & run npm run docs-runLocalDocker to run docs locally.

Related issues, RFCs

#153

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
  • 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

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 Dec 8, 2021
@dreamorosi dreamorosi added this to the beta-release milestone Dec 8, 2021
@dreamorosi dreamorosi self-assigned this Dec 8, 2021
@dreamorosi dreamorosi linked an issue Dec 8, 2021 that may be closed by this pull request
@dreamorosi dreamorosi requested review from flochaz and ijemmy December 8, 2021 15:21
@dreamorosi dreamorosi requested a review from flochaz December 10, 2021 12:37
@dreamorosi dreamorosi marked this pull request as draft December 10, 2021 13:49
@dreamorosi
Copy link
Contributor Author

Converted to draft until I've worked also on JSDocs for the module, depends on:

@dreamorosi dreamorosi linked an issue Dec 10, 2021 that may be closed by this pull request
8 tasks
flochaz
flochaz previously approved these changes Dec 12, 2021
@flochaz flochaz changed the title (docs): Tracer docs chore(docs): Tracer docs Dec 12, 2021
saragerion
saragerion previously approved these changes Dec 13, 2021
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.

Looking good!
Minor: in the code snippets you are not highlighting the important lines of code.
Example: line 6 in the first code snippet of this section:
http://localhost:8000/core/tracer/#patching-aws-sdk-clients

@dreamorosi dreamorosi dismissed stale reviews from saragerion and flochaz via 60d3c27 December 14, 2021 18:31
@dreamorosi dreamorosi marked this pull request as ready for review December 15, 2021 12:37
@dreamorosi
Copy link
Contributor Author

Recap of changes:

  • Created JSDocs for all public & private methods of the Tracer Class
  • Created documentation (MKDocs) for the module

Note: There are some placeholder/TODOs in both annotations & docs for the middleware which I'll complement in the appropriate PR.

@flochaz flochaz merged commit a0b9c6d into main Dec 15, 2021
@flochaz flochaz deleted the docs/tracer branch December 15, 2021 15:00
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 tracer This item relates to the Tracer Utility
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: add tracer documentation Feature request: Tracing utility
3 participants