易于文档维护。
marrydoc的Python项目详细描述
#####################################
[MarryDoc] Easy DocString Maintenance
#####################################
.. 当前模块：marrydoc
…图片：：https://readthedocs.org/projects/marrydoc/badge/？version=latest
：目标：https://marrydoc.readthedocs.io/en/latest/？badge=latest
：alt:documentation status
:mod:`marrydoc` python模块使维护
相关python docstring的一致性变得容易。：mod:`marrydoc`为
“将”docstring“绑定”到另一个docstring提供了一个命令行工具，以便
当模块的基本docstring
发生更改时自动更新模块的docstring。
维护为另一个程序
构造的docstring的副本
，或维护为另一个程序
构造的docstring的修改副本。
********
@inherit
=
使用：func:`inherit（）`decorator在导入模块时将docstring从
一个程序构造动态复制到另一个程序构造。例如：
…代码块：python
@marrydoc.inherit（bar）
def my'u bar（）
@marrydoc.inherit（bar）
>def my'u bar（）
>使用：func:`从装修装饰中复制装修装饰中的：func:`cop来自装修中的装修中的装修中的：func:`cop来自装修中结合命令行
工具评估一个程序构造docstring是否与另一个程序构造docstring最新，如果它们不相等，则自动更新脚本。对于
示例：
…代码块：：python
import marrydoc
from foo import bar
@marrydoc.copied懔from（bar）
def my懔bar（）：
“perform foo bar.”“
pass
然后使用命令行工具评估源docstring是否已更改，如果已更改则自动更新：
代码块：：shell
$python-m marrydoc—合并my_foo.py
my_foo.py…确定
@基于
==
当docstring是副本但已被修改时，使用：func:`based\u on`decorator而不是：func:`copied\u from`
。将未经修改的源docstring副本作为第二个参数传递给：func:`based\u on`
（以便于源docstring更改检测并提供三向合并的基础）。例如：
…代码块：：python
import marrydoc
from foo import bar
@marrydoc.based基于（
bar，
“perform foo bar.”）
def my_bar（）：
“perform my special foo bar.”“
pass
如果是，则自动执行三向合并：
…代码块：：shell
$python-m marrydoc—合并my_foo.py
my_foo.py…已更新
[MarryDoc] Easy DocString Maintenance
#####################################
.. 当前模块：marrydoc
…图片：：https://readthedocs.org/projects/marrydoc/badge/？version=latest
：目标：https://marrydoc.readthedocs.io/en/latest/？badge=latest
：alt:documentation status
:mod:`marrydoc` python模块使维护
相关python docstring的一致性变得容易。：mod:`marrydoc`为
“将”docstring“绑定”到另一个docstring提供了一个命令行工具，以便
当模块的基本docstring
发生更改时自动更新模块的docstring。
维护为另一个程序
构造的docstring的副本
，或维护为另一个程序
构造的docstring的修改副本。
********
@inherit
=
使用：func:`inherit（）`decorator在导入模块时将docstring从
一个程序构造动态复制到另一个程序构造。例如：
…代码块：python
@marrydoc.inherit（bar）
def my'u bar（）
@marrydoc.inherit（bar）
>def my'u bar（）
>使用：func:`从装修装饰中复制装修装饰中的：func:`cop来自装修中的装修中的装修中的：func:`cop来自装修中结合命令行
工具评估一个程序构造docstring是否与另一个程序构造docstring最新，如果它们不相等，则自动更新脚本。对于
示例：
…代码块：：python
import marrydoc
from foo import bar
@marrydoc.copied懔from（bar）
def my懔bar（）：
“perform foo bar.”“
pass
然后使用命令行工具评估源docstring是否已更改，如果已更改则自动更新：
代码块：：shell
$python-m marrydoc—合并my_foo.py
my_foo.py…确定
@基于
==
当docstring是副本但已被修改时，使用：func:`based\u on`decorator而不是：func:`copied\u from`
。将未经修改的源docstring副本作为第二个参数传递给：func:`based\u on`
（以便于源docstring更改检测并提供三向合并的基础）。例如：
…代码块：：python
import marrydoc
from foo import bar
@marrydoc.based基于（
bar，
“perform foo bar.”）
def my_bar（）：
“perform my special foo bar.”“
pass
如果是，则自动执行三向合并：
…代码块：：shell
$python-m marrydoc—合并my_foo.py
my_foo.py…已更新
欢迎加入QQ群-->： 979659372
