This repository has been archived by the owner on May 23, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 108
Fix grammatical errors and add Licence information #100
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -91,7 +91,7 @@ The package contains two bundles built with webpack that can be included using a | |
### Usage with TypeScript | ||
|
||
Since the source is written in TypeScript, if you are using TypeScript, you can just `npm install` the package and it will work out of the box. | ||
This is especially useful for implementators who want to typecheck their implementation with the base interface. | ||
This is especially useful for implementors who want to type check their implementation with the base interface. | ||
|
||
### Global tracer | ||
|
||
|
@@ -103,7 +103,7 @@ opentracing.initGlobalTracer(new CustomTracer()); | |
const tracer = opentracing.globalTracer(); | ||
``` | ||
|
||
Note: `globalTracer()` returns a wrapper on the actual tracer object. This is done for convenience of use as it ensures that the function will always return a non-null object. This can be helpful in cases where it is difficult or impossible to know precisely when `initGlobalTracer` is called (for example, when writing a utility library that does not control the initialization process). For more precise control, individual `Tracer` objects can be used instead of the global tracer. | ||
Note: `globalTracer()` returns a wrapper on the actual tracer object. This is done for the convenience of use as it ensures that the function will always return a non-null object. This can be helpful in cases where it is difficult or impossible to know precisely when `initGlobalTracer` is called (for example, when writing a utility library that does not control the initialization process). For more precise control, individual `Tracer` objects can be used instead of the global tracer. | ||
|
||
## API Documentation | ||
|
||
|
@@ -127,7 +127,7 @@ The project is written in TypeScript and built using a npm scripts. Run: | |
|
||
### Custom tracer implementation | ||
|
||
Implementations can subclass `opentracing.Trace`, `opentracing.Span`, and the other API classes to build a OpenTracing tracer and implement the underscore prefixed methods such as `_addTag` to pick up a bit of common code implemented in the base classes. | ||
Implementations can subclass `opentracing.Trace`, `opentracing.Span`, and the other API classes to build an OpenTracing tracer and implement the underscore prefixed methods such as `_addTag` to pick up a bit of common code implemented in the base classes. | ||
|
||
### API compatibility testing | ||
|
||
|
@@ -140,7 +140,7 @@ apiCompatibilityChecks(() => new CustomTracer()); | |
|
||
### MockTracer | ||
|
||
An minimal example tracer is provided in the `src/mock_tracer` directory of the source code. | ||
A minimal example tracer is provided in the `src/mock_tracer` directory of the source code. | ||
|
||
[ci-img]: https://travis-ci.org/opentracing/opentracing-javascript.svg?branch=master | ||
[cov-img]: https://coveralls.io/repos/github/opentracing/opentracing-javascript/badge.svg?branch=master | ||
|
@@ -149,3 +149,7 @@ An minimal example tracer is provided in the `src/mock_tracer` directory of the | |
[ci]: https://travis-ci.org/opentracing/opentracing-javascript | ||
[cov]: https://coveralls.io/github/opentracing/opentracing-javascript?branch=master | ||
[npm]: https://www.npmjs.com/package/opentracing | ||
|
||
##LICENSE | ||
|
||
Copyright (c) 2016 Resonance Labs, Inc | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. copyright exists in individual source files. This section should as simple as https://github.com/jaegertracing/jaeger-client-java#license. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the shortcuts must be at the end of the file