From 3f3785c82678c863096c289c8e7d4e1020b67145 Mon Sep 17 00:00:00 2001 From: Huan LI Date: Tue, 13 Mar 2018 22:05:25 +0800 Subject: [PATCH] rename Example to Examples and update docs (#1127) --- docs/index.md | 22 +++++++++++----------- src/contact.ts | 2 +- src/friend-request.ts | 2 +- src/message.ts | 4 ++-- src/room.ts | 2 +- src/wechaty.ts | 2 +- 6 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/index.md b/docs/index.md index 6aa06d2a..c5b95a08 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# Wechaty v0.13.79 Documentation +# Wechaty v0.13.80 Documentation * https://blog.chatie.io ## Classes @@ -7,7 +7,7 @@
Contact

All wechat contacts(friend) will be encapsulated as a Contact.

Contact is Sayable, -Example/Contact-Bot

+Examples/Contact-Bot

FriendRequest

Send, receive friend request, and friend confirmation events.

@@ -16,12 +16,12 @@
  • receive request(in friend event)
  • confirmation friendship(friend event)
    • -

    Example/Friend-Bot

    +

    Examples/Friend-Bot

    Message

    All wechat messages will be encapsulated as a Message.

    Message is Sayable, -Example/Ding-Dong-Bot

    +Examples/Ding-Dong-Bot

    MediaMessage

    Meidia Type Message

    @@ -29,7 +29,7 @@
    Room

    All wechat rooms(groups) will be encapsulated as a Room.

    Room is Sayable, -Example/Room-Bot

    +Examples/Room-Bot

    Wechaty

    Main bot class.

    @@ -69,7 +69,7 @@ All wechat contacts(friend) will be encapsulated as a Contact. `Contact` is `Sayable`, -[Example/Contact-Bot](https://github.com/Chatie/wechaty/blob/master/example/contact-bot.ts) +[Examples/Contact-Bot](https://github.com/Chatie/wechaty/blob/master/examples/contact-bot.ts) **Kind**: global class @@ -347,7 +347,7 @@ Send, receive friend request, and friend confirmation events. 2. receive request(in friend event) 3. confirmation friendship(friend event) -[Example/Friend-Bot](https://github.com/Chatie/wechaty/blob/master/example/friend-bot.ts) +[Examples/Friend-Bot](https://github.com/Chatie/wechaty/blob/master/examples/friend-bot.ts) **Kind**: global class @@ -387,7 +387,7 @@ Accept a friend request All wechat messages will be encapsulated as a Message. `Message` is `Sayable`, -[Example/Ding-Dong-Bot](https://github.com/Chatie/wechaty/blob/master/example/ding-dong-bot.ts) +[Examples/Ding-Dong-Bot](https://github.com/Chatie/wechaty/blob/master/examples/ding-dong-bot.ts) **Kind**: global class @@ -415,7 +415,7 @@ All wechat messages will be encapsulated as a Message. Reply a Text or Media File message to the sender. **Kind**: instance method of [Message](#Message) -**See**: [Example/ding-dong-bot](https://github.com/Chatie/wechaty/blob/master/example/ding-dong-bot.ts) +**See**: [Examples/ding-dong-bot](https://github.com/Chatie/wechaty/blob/master/examples/ding-dong-bot.ts) | Param | Type | | --- | --- | @@ -675,7 +675,7 @@ You need to detect the following conditions in the message event, which can be f All wechat rooms(groups) will be encapsulated as a Room. `Room` is `Sayable`, -[Example/Room-Bot](https://github.com/Chatie/wechaty/blob/master/example/room-bot.ts) +[Examples/Room-Bot](https://github.com/Chatie/wechaty/blob/master/examples/room-bot.ts) **Kind**: global class @@ -1099,7 +1099,7 @@ await bot.start() **Kind**: instance method of [Wechaty](#Wechaty) **Returns**: [Wechaty](#Wechaty) - - this for chain -More Example Gist: [Example/Friend-Bot](https://github.com/wechaty/wechaty/blob/master/example/friend-bot.ts) +More Example Gist: [Examples/Friend-Bot](https://github.com/wechaty/wechaty/blob/master/examples/friend-bot.ts) | Param | Type | Description | | --- | --- | --- | diff --git a/src/contact.ts b/src/contact.ts index c30a3b63..42283fc3 100644 --- a/src/contact.ts +++ b/src/contact.ts @@ -102,7 +102,7 @@ const specialContactList: string[] = [ * All wechat contacts(friend) will be encapsulated as a Contact. * * `Contact` is `Sayable`, - * [Example/Contact-Bot]{@link https://github.com/Chatie/wechaty/blob/master/examples/contact-bot.ts} + * [Examples/Contact-Bot]{@link https://github.com/Chatie/wechaty/blob/master/examples/contact-bot.ts} */ export class Contact implements Sayable { private static pool = new Map() diff --git a/src/friend-request.ts b/src/friend-request.ts index db08060f..1a31bd00 100644 --- a/src/friend-request.ts +++ b/src/friend-request.ts @@ -31,7 +31,7 @@ import Contact from './contact' * 2. receive request(in friend event) * 3. confirmation friendship(friend event) * - * [Example/Friend-Bot]{@link https://github.com/Chatie/wechaty/blob/master/examples/friend-bot.ts} + * [Examples/Friend-Bot]{@link https://github.com/Chatie/wechaty/blob/master/examples/friend-bot.ts} */ export abstract class FriendRequest { diff --git a/src/message.ts b/src/message.ts index 64c67915..1e7d133c 100644 --- a/src/message.ts +++ b/src/message.ts @@ -53,7 +53,7 @@ export type TypeName = 'attachment' * All wechat messages will be encapsulated as a Message. * * `Message` is `Sayable`, - * [Example/Ding-Dong-Bot]{@link https://github.com/Chatie/wechaty/blob/master/examples/ding-dong-bot.ts} + * [Examples/Ding-Dong-Bot]{@link https://github.com/Chatie/wechaty/blob/master/examples/ding-dong-bot.ts} */ export class Message implements Sayable { /** @@ -186,7 +186,7 @@ export class Message implements Sayable { /** * Reply a Text or Media File message to the sender. * - * @see {@link https://github.com/Chatie/wechaty/blob/master/examples/ding-dong-bot.ts|Example/ding-dong-bot} + * @see {@link https://github.com/Chatie/wechaty/blob/master/examples/ding-dong-bot.ts|Examples/ding-dong-bot} * @param {(string | MediaMessage)} textOrMedia * @param {(Contact|Contact[])} [replyTo] * @returns {Promise} diff --git a/src/room.ts b/src/room.ts index 4209725a..ce237692 100644 --- a/src/room.ts +++ b/src/room.ts @@ -80,7 +80,7 @@ export interface MemberQueryFilter { * All wechat rooms(groups) will be encapsulated as a Room. * * `Room` is `Sayable`, - * [Example/Room-Bot]{@link https://github.com/Chatie/wechaty/blob/master/examples/room-bot.ts} + * [Examples/Room-Bot]{@link https://github.com/Chatie/wechaty/blob/master/examples/room-bot.ts} */ export class Room extends EventEmitter implements Sayable { private static pool = new Map() diff --git a/src/wechaty.ts b/src/wechaty.ts index 74e75075..73f67297 100644 --- a/src/wechaty.ts +++ b/src/wechaty.ts @@ -294,7 +294,7 @@ export class Wechaty extends EventEmitter implements Sayable { * @param {WechatyEventFunction} listener - Depends on the WechatyEvent * @return {Wechaty} - this for chain * - * More Example Gist: [Example/Friend-Bot]{@link https://github.com/wechaty/wechaty/blob/master/examples/friend-bot.ts} + * More Example Gist: [Examples/Friend-Bot]{@link https://github.com/wechaty/wechaty/blob/master/examples/friend-bot.ts} * * @example Event:scan * wechaty.on('scan', (url: string, code: number) => { -- GitLab