Skip to content

Commit 5960961

Browse files
willyliuwillyliu
authored
Merge pull request #3 from ajhsu/feature/correct-references-in-example
docs: Correct the reference names in example code
2 parents bee3166 + 492b437 commit 5960961

4 files changed

Lines changed: 7 additions & 7 deletions

File tree

‎src/api/ArtistFetcher.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export default class ArtistFetcher extends Fetcher {
3434
* Fetch metadata of the artist you find.
3535
*
3636
* @return {Promise}
37-
* @example api.Artist.setArtistID('Cnv_K6i5Ft4y41SxLy').fetchMetadata()
37+
* @example api.artistFetcher.setArtistID('Cnv_K6i5Ft4y41SxLy').fetchMetadata()
3838
* @see https://docs-en.kkbox.codes/v1.1/reference#artists-artist_id
3939
*/
4040
fetchMetadata() {
@@ -64,7 +64,7 @@ export default class ArtistFetcher extends Fetcher {
6464
* @param {number} [limit] - The size for one page.
6565
* @param {number} [offset] - The offset index for first element.
6666
* @return {Promise}
67-
* @example api.Artist.setArtistID('Cnv_K6i5Ft4y41SxLy').fetchTopTracks()
67+
* @example api.artistFetcher.setArtistID('Cnv_K6i5Ft4y41SxLy').fetchTopTracks()
6868
* @see https://docs-en.kkbox.codes/v1.1/reference#artists-artist_id-toptracks
6969
*/
7070
fetchTopTracks(limit = undefined, offset = undefined) {

‎src/api/GenreStationFetcher.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export default class GenreStationFetcher extends Fetcher {
2424
* @param {number} [limit] - The size for one page.
2525
* @param {number} [offset] - The offset index for first element.
2626
* @return {Promise}
27-
* @example api.GenreStation.fetchAllGenreStations()
27+
* @example api.genreStationFetcher.fetchAllGenreStations()
2828
* @see https://docs-en.kkbox.codes/v1.1/reference#genrestations
2929
*/
3030
fetchAllGenreStations(limit = undefined, offset = undefined) {
@@ -51,7 +51,7 @@ export default class GenreStationFetcher extends Fetcher {
5151
* Fetch metadata of the genre station with the genre station fetcher.
5252
*
5353
* @return {Promise}
54-
* @example api.GenreStation.setGenreStationID('TYq3EHFTl-1EOvJM5Y').fetchMetadata()
54+
* @example api.genreStationFetcher.setGenreStationID('TYq3EHFTl-1EOvJM5Y').fetchMetadata()
5555
* @see https://docs-en.kkbox.codes/v1.1/reference#genrestations-station_id
5656
*/
5757
fetchMetadata() {

‎src/api/SharedPlaylistFetcher.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export default class SharedPlaylistFetcher extends Fetcher {
3434
* Fetch metadata of the shared playlist with the shared playlist fetcher.
3535
*
3636
* @return {Promise}
37-
* @example api.SharedPlaylistFetcher.setPlaylistID('4nUZM-TY2aVxZ2xaA-').fetchMetadata()
37+
* @example api.sharedPlaylistFetcher.setPlaylistID('4nUZM-TY2aVxZ2xaA-').fetchMetadata()
3838
* @see https://docs-en.kkbox.codes/v1.1/reference#sharedplaylists-playlist_id
3939
*/
4040
fetchMetadata() {
@@ -56,7 +56,7 @@ export default class SharedPlaylistFetcher extends Fetcher {
5656
* @param {number} [limit] - The size for one page.
5757
* @param {number} [offset] - The offset index for first element.
5858
* @return {Promise}
59-
* @example api.SharedPlaylistFetcher.setPlaylistID('4nUZM-TY2aVxZ2xaA-').fetchTracks()
59+
* @example api.sharedPlaylistFetcher.setPlaylistID('4nUZM-TY2aVxZ2xaA-').fetchTracks()
6060
* @see https://docs-en.kkbox.codes/v1.1/reference#sharedplaylists-playlist_id-tracks
6161
*/
6262
fetchTracks(limit = undefined, offset = undefined) {

‎src/api/TrackFetcher.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export default class TrackFetcher extends Fetcher {
3434
* Get metadata of the track with the track fetcher.
3535
*
3636
* @return {Promise}
37-
* @example api.Track.setTrackID('KpnEGVHEsGgkoB0MBk').fetchMetadata()
37+
* @example api.trackFetcher.setTrackID('KpnEGVHEsGgkoB0MBk').fetchMetadata()
3838
* @see https://docs-en.kkbox.codes/v1.1/reference#tracks-track_id
3939
*/
4040
fetchMetadata() {

0 commit comments

Comments
 (0)