-
Notifications
You must be signed in to change notification settings - Fork 237
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.
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
💥Refactor the document structure #338
Conversation
Codecov Report
@@ Coverage Diff @@
## master #338 +/- ##
=======================================
Coverage 41.13% 41.13%
=======================================
Files 27 27
Lines 1928 1928
=======================================
Hits 793 793
Misses 1135 1135
Flags with carried forward coverage won't be shown. Click here to find out more. |
Your pr is so great and contains so many works which need some time to read it. I will reply as soon as possible, and In this period, you can do some research on: merging the docs of python-wechaty and python-wechaty-plugin-contrib. Please feel free to tell me more if you have any cons. |
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.
Your docs is great.
* [.find_all\(\)](message.md#Message.findAll) ⇒ `List[Message]` | ||
* [.find_all\(\)](message.md#Message.findAll) ⇒ `List[Message]` --> | ||
|
||
|
||
### ~~def from\(self\)~~ ⇒ `Contact` | ||
<!-- ### ~~def from\(self\)~~ ⇒ `Contact` | ||
|
||
已弃用, 详见[message.talker\(\)](message.md#Message+talker) | ||
已弃用, 详见[message.talker\(\)](message.md#Message+talker) --> | ||
|
||
### def talker\(self\) ⇒ `Contact` | ||
<!-- ### def talker\(self\) ⇒ `Contact` | ||
|
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.
This desc style is from source of typescript, we should change it to mkdocs style, the same as the api module. How do you think about it?
this desc looks weired.
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.
Yes, I found that many of the documentation descriptions were lifted directly from the typescript section, and these codes should be rewritten by python.
And I will rewrite the corresponding section later when I write this part of the document.
Wechaty Contributors NominationLink to wechaty/PMC#16 |
This commit have lots of changes about document structure as follow:
docs/api
folder, you can ignore it for a while)