Skip to content

docs: make version description more clear #71

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.

Sign up for GitHub

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
jpoehnelt merged 1 commit into from
Oct 12, 2020
Merged

docs: make version description more clear #71

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,14 @@ export interface LoaderOptions {
/**
* In your application you can specify release channels or version numbers:
*
* The weekly channel is specified with `version=weekly`. This channel is
* The weekly version is specified with `version=weekly`. This version is
* updated once per week, and is the most current.
*
* ```
* const loader = Loader({apiKey, version: 'weekly'});
* ```
*
* The quarterly channel is specified with `version=quarterly`. This channel
* The quarterly version is specified with `version=quarterly`. This version
* is updated once per quarter, and is the most predictable.
*
* ```
Expand All @@ -66,10 +66,9 @@ export interface LoaderOptions {
* const loader = Loader({apiKey, version: '3.40'});
* ```
*
* If you do not explicitly specify a channel or version, you will receive the
* weekly channel by default. If you specify an invalid version, you will
* receive your default channel.
*/
* If you do not explicitly specify a version, you will receive the
* weekly version by default.
*/
version?: string;
/**
* The id of the script tag. Before adding a new script, the Loader will check for an existing one.
Expand Down