Skip to content
This repository has been archived by the owner on Aug 5, 2020. It is now read-only.

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
youfou committed Mar 15, 2017
1 parent 9708cac commit 9261991
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 17 deletions.
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,11 @@ wxpy: 用 Python 玩微信

* 全面对象化接口,调用更优雅
* 默认多线程响应消息,回复更快
* 可在运行中探索代码,无需涂涂改改
* 包含 共同好友、图灵机器人 等实用组件
* `愉快的探索和调试 <http://wxpy.readthedocs.io/zh/latest/console.html>`_,无需涂涂改改
* 包含 共同好友、图灵机器人 等 `实用组件 <http://wxpy.readthedocs.io/zh/latest/utils.html>`_
* 只需两行代码,在其他项目中用微信接收警告
* 可混合使用 itchat 的原接口
* 覆盖常用功能
* 覆盖常见基本功能
* 发送文本、图片、视频、文件
* 通过关键词或用户属性搜索 好友、群聊、群成员 等
* 获取好友/群成员昵称、备注、性别、地区
Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,11 @@ wxpy: 用 Python 玩微信

* 全面对象化接口,调用更优雅
* 默认多线程响应消息,回复更快
* :doc:`在运行中探索代码 <console>`,无需涂涂改改
* :doc:`愉快的探索和调试 <console>`,无需涂涂改改
* 包含 :any:`共同好友 <mutual_friends>`、:any:`图灵机器人 <Tuling>` 等实用组件
* 只需两行代码,在其他项目中 :doc:`用微信接收警告 <logging_with_wechat>`
* 可混合使用 itchat 的原接口
* 覆盖常用功能
* 覆盖常见基本功能
* 发送文本、图片、视频、文件
* 通过关键词或用户属性搜索 好友、群聊、群成员 等
* 获取好友/群成员昵称、备注、性别、地区
Expand Down
24 changes: 13 additions & 11 deletions docs/utils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,6 @@
额外内置了一些实用的小组件,可按需使用。


确保查找结果的唯一性
------------------------------

.. autofunction:: ensure_one

代码示例::

bot = Bot()
# 确保只找到了一个叫"游否"的好友,并返回这个好友
my_friend = ensure_one(bot.search('游否'))

图灵机器人
------------------------------

Expand Down Expand Up @@ -54,3 +43,16 @@
------------------------------

.. autofunction:: dont_raise_response_error


确保查找结果的唯一性
------------------------------

.. autofunction:: ensure_one

代码示例::

bot = Bot()
# 确保只找到了一个叫"游否"的好友,并返回这个好友
my_friend = ensure_one(bot.search('游否'))

2 changes: 1 addition & 1 deletion wxpy/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ def reply_my_friend(msg):
from .utils import dont_raise_response_error, embed, ensure_one, mutual_friends

__title__ = 'wxpy'
__version__ = '0.2.6.dev'
__version__ = '0.2.6'
__author__ = 'Youfou'
__license__ = 'MIT'
__copyright__ = '2017, Youfou'
Expand Down

0 comments on commit 9261991

Please sign in to comment.