Edit room doc #1570
Merged
Edit room doc #1570
Conversation
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
Update from upstream repo chatie/wechaty@master
Update from upstream repo chatie/wechaty@master
Update from upstream repo chatie/wechaty@master
Update from upstream repo chatie/wechaty@master
… docs and example
huan
requested changes
Aug 27, 2018
src/user/room.ts
Outdated
| * @returns {Promise<Contact[]>} | ||
| * @example | ||
| * const room_list:Conatct[]|null = await room.findAll() | ||
| * if(room_list) |
There was a problem hiding this comment.
Could you please follow the naming style from the JS community instead of a python style?
Please change room_list to roomList, and so do others.
huan
requested changes
Aug 27, 2018
src/user/room.ts
Outdated
| * console.log("room all member list: ", room_list) | ||
| * const member_contact_list: Conatct[]|null =await room.findAll("abc") | ||
| * const memberContactList: Conatct[] | null =await room.findAll("abc") |
There was a problem hiding this comment.
"abc" to 'abc' please, because all Wechaty source code is using '
I'll merge this PR after you fix this, thanks!
huan
reviewed
Aug 27, 2018
src/user/room.ts
Outdated
| * @example | ||
| * const roomList:Conatct[] | null = await room.findAll() | ||
| * if(roomList) | ||
| * console.log("room all member list: ", room_list) |
There was a problem hiding this comment.
"abc" to 'abc' please, because all Wechaty source code is using '
I'll merge this PR after you fix this, thanks!
huan
requested changes
Aug 27, 2018
src/user/room.ts
Outdated
| @@ -875,7 +875,7 @@ export class Room extends Accessory implements Sayable { | |||
| * const roomList:Conatct[] | null = await room.findAll() | |||
| * if(roomList) | |||
| * console.log("room all member list: ", room_list) | |||
| * const memberContactList: Conatct[] | null =await room.findAll("abc") | |||
| * const memberContactList: Conatct[] | null =await room.findAll('abc') | |||
| * console.log("contact list with all name, room alias, alias are abc:", member_contact_list) | |||
There was a problem hiding this comment.
There's more double quotas, please fix them all.
huan
requested changes
Aug 27, 2018
src/user/room.ts
Outdated
| * @example | ||
| * const roomList:Conatct[] | null = await room.findAll() | ||
| * if(roomList) | ||
| * console.log("room all member list: ", room_list) |
|
Awesome, thank you very much for the contribution! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I'm submitting added documentation
Checklist
Description
Edit and add some documentation in room.ts and API list in README.md
Does this PR introduce a breaking change?