Style-Doc

Style-Doc 用于 Python 的 docstrings 和 reStructuredText (rst) 文档，颜色为黑色。它可以用来格式化 Python 文件中的 docstrings（Google docstring 格式）或者 reStructuredText 文档。

Style-Doc 可以处理 Linux、Windows 和 Mac 的风格行尾。输出结果将转换为 \n 的 Linux 行尾。

目录

• 维护者
• 安装
• 使用方法
• 示例
• 支持和反馈
• 报告安全漏洞
• 贡献
• 行为准则
• 许可协议

维护者

本项目由 One Conversation 团队维护，该团队隶属于 德国电信 AG。它基于 style_doc.py 脚本，该脚本由 HuggingFace 团队提供。非常感谢您允许我们将它作为独立的软件包发布 🤗 ♥。

安装

Style-Doc 可在 Python 包索引 (PyPI) 上找到。可以使用 pip 进行安装

$ pip install style-doc

使用方法

$ style-doc --help
usage: style-doc [-h] [--max_len MAX_LEN] [--check_only] [--py_only]
                 [--rst_only]
                 files [files ...]

positional arguments:
  files              file(s) or folder(s) to restyle

optional arguments:
  -h, --help         show this help message and exit
  --max_len MAX_LEN  maximum length of lines, default: 119
  --check_only       only check and not fix styling issues
  --py_only          only check py files
  --rst_only         only check rst files

示例

• 格式化 src 和 docs 文件夹中所有 docstrings（.py 文件）和 rst 文件，行长度为 99
  style-doc --max_len 99 src docs
• 检查 src 和 docs 文件夹中所有 docstrings（.py 文件）和 rst 文件的行长度为 99
  style-doc --max_len 99 --check_only src docs
• 格式化 src 文件夹中所有 docstrings（仅 .py 文件），行长度为 99
  style-doc --max_len 99 --py_only src
• 检查 src 文件夹中所有 docstrings（仅 .py 文件），行长度为 99
  style-doc --max_len 99 --check_only --py_only src
• 仅格式化 docs 文件夹中所有 rst 文件，行长度为 99
  style-doc --max_len 99 --rst_only docs
• 仅检查 docs 文件夹中所有 rst 文件，行长度为 99
  style-doc --max_len 99 --check_only --rst_only docs

要将 Style-Doc（以及更多检查）集成到您的 GitHub Actions 中，请参阅我们的 static_checks.yml 示例以及我们在 setup.py 中的配置。

支持和反馈

以下渠道可用于讨论、反馈和支持请求

• 在我们的 GitHub 仓库中创建一个问题
• 给我们开源团队发送电子邮件

报告安全漏洞

我们致力于安全和数据隐私，以确保您的数据安全。我们感谢安全研究人员和用户首先向我们报告漏洞。为确保您的请求得到及时处理，并确保漏洞信息不公开，请遵循以下指南。

请勿直接在 GitHub 上报告安全漏洞。GitHub 问题可以被公开查看，因此会导致直接公开。

有关数据隐私、安全概念和其他媒体请求的问题，请联系 opensource@telekom.de 邮箱。

贡献

我们致力于开源，这意味着我们鼓励所有感兴趣的个人参与并成为我们的开发者社区的一部分。

鼓励贡献和反馈。有关如何贡献以及更多信息，请参阅我们的 贡献指南。

行为准则

本项目采用了 贡献者公约 作为我们的行为准则。有关详细信息，请参阅我们的 贡献者公约行为准则。所有贡献者都必须遵守行为准则。

许可协议

版权 (c) 2020 HuggingFace Inc. 团队
版权 (c) 2021 Philip May, 德国电信 AG

本文件根据Apache License, Version 2.0（以下简称“许可证”）授权；除非遵守许可证规定，否则不得使用此文件。您可以在以下地址获取许可证副本：

https://apache.ac.cn/licenses/LICENSE-2.0

除非适用法律要求或书面同意，否则在许可证下分发的软件按“现状”基础分发，不提供任何形式的明示或暗示担保。有关许可证的权限和限制的具体语言，请参阅许可证。