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

doc: update broken references to source files #663

Merged
merged 3 commits into from
Feb 5, 2018
Merged

Conversation

kjin
Copy link
Contributor

@kjin kjin commented Feb 2, 2018

Fixes #662

@kjin kjin requested a review from ofrobots February 2, 2018 20:25
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Feb 2, 2018
Copy link
Contributor

@ofrobots ofrobots left a comment

Choose a reason for hiding this comment

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

LGTM once nit addressed.

doc/trace-api.md Outdated
@@ -80,7 +80,7 @@ It is highly recommended for plugins to set this header field in responses, _if_
* Returns `string`
* Returns a string that should be set in the response headers in a traced request. If incomingTraceContext is falsy (indicating that the incoming request didn't have a trace context), this function returns an empty string.

This function is usually called from within the function passed to `runInRootSpan`. See any of the built-in plugins ([express](../src/plugins/plugin-express.js#L42)) for an example. Note that the value for `isTraced` is based on the value of the root span - if a root span was created, that means that this request is being traced.
This function is usually called from within the function passed to `runInRootSpan`. See any of the built-in plugins ([express](https://github.com/GoogleCloudPlatform/cloud-trace-nodejs/blob/84bf9cd56fadf63ec3d341aac4cf79410c815d0d/src/plugins/plugin-express.ts#L42)) for an example. Note that the value for `isTraced` is based on the value of the root span - if a root span was created, that means that this request is being traced.

This comment was marked as spam.

@codecov
Copy link

codecov bot commented Feb 2, 2018

Codecov Report

Merging #663 into master will decrease coverage by 0.71%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #663      +/-   ##
==========================================
- Coverage   90.66%   89.95%   -0.72%     
==========================================
  Files          30       30              
  Lines        1403     1403              
  Branches      288      288              
==========================================
- Hits         1272     1262      -10     
- Misses         54       57       +3     
- Partials       77       84       +7
Impacted Files Coverage Δ
src/cls.ts 93.75% <0%> (-6.25%) ⬇️
src/plugins/plugin-http.ts 90.24% <0%> (-4.88%) ⬇️
src/span-data.ts 92.72% <0%> (-3.64%) ⬇️
src/index.ts 90% <0%> (-2.86%) ⬇️
src/trace-api.ts 91.11% <0%> (-1.12%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 54dd734...2542711. Read the comment docs.

@ofrobots ofrobots merged commit 72b493d into master Feb 5, 2018
@ofrobots ofrobots deleted the kjin-patch-2 branch February 5, 2018 13:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants