{ "info": { "author": "huntzhan", "author_email": "programmer.zhx@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 1 - Planning", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Topic :: Software Development :: Libraries" ], "description": "# zh-doclint\n\nNote: This project is highly related to Chinese, so the document is writtern in Chinese.\n\n## \u7b80\u4ecb\n\n\u4e00\u4e2a\u68c0\u67e5\u6587\u6863\u98ce\u683c\u7684\u5de5\u5177\u3002\n\n## \u5b89\u88c5\n\n```\npip install zh-doclint\n```\n\n## \u4f7f\u7528\n\n```shell\n$ zh-doclint --help\nUsage: zh-doclint [OPTIONS] FPATH\n\nOptions:\n --version Show the version and exit.\n --help Show this message and exit.\n\n$ ccat doc.md \n\u6211\u8ddf\u4f60\u8bb2\uff0c\u8fd9\u91cc\u6709\u95ee\u9898. \u8fd9\u4e2a\n case\u4e00\u770b\u5c31\u662f\u201c\u836f\u4e38\u201d\n\n$ zh-doclint doc.md \n==========================================\nE101: \u82f1\u6587\u4e0e\u975e\u6807\u70b9\u7684\u4e2d\u6587\u4e4b\u95f4\u9700\u8981\u6709\u4e00\u4e2a\u7a7a\u683c\n==========================================\nLINE: 2\n case\u4e00\u770b\u5c31\u662f\u201c\n -\uff0d\n...............\n\n==================================================\nE201: \u53ea\u6709\u4e2d\u6587\u6216\u4e2d\u82f1\u6587\u6df7\u6392\u4e2d\uff0c\u4e00\u5f8b\u4f7f\u7528\u4e2d\u6587\u5168\u89d2\u6807\u70b9\n==================================================\nLINE: 1\n\u91cc\u6709\u95ee\u9898.\n\u3000\u3000\u3000\u3000-\n.........\n\n==========================================================\nE204: \u4e2d\u6587\u6587\u6848\u4e2d\u4f7f\u7528\u4e2d\u6587\u5f15\u53f7\u300c\u300d\u548c\u300e\u300f\uff0c\u5176\u4e2d\u300c\u300d\u4e3a\u5916\u5c42\u5f15\u53f7\n==========================================================\nLINE: 2\n\u4e00\u770b\u5c31\u662f\u201c\u836f\u4e38\n\u3000\u3000\u3000\u3000\uff0d\n..............\nLINE: 2\n\u662f\u201c\u836f\u4e38\u201d\n\u3000\u3000\u3000\u3000\uff0d\n..........\n```\n\n## \u652f\u6301\u7684\u68c0\u67e5\u9879\u76ee\n\n| \u9519\u8bef\u7801 | \u68c0\u67e5\u8303\u56f4 | \u63cf\u8ff0 |\n| ---- | -------- | ------------------------------------------------------------------------------ |\n| E101 | \u6bb5\u843d | \u82f1\u6587\u4e0e\u975e\u6807\u70b9\u7684\u4e2d\u6587\u4e4b\u95f4\u9700\u8981\u6709\u4e00\u4e2a\u7a7a\u683c |\n| E102 | \u6bb5\u843d | \u6570\u5b57\u4e0e\u975e\u6807\u70b9\u7684\u4e2d\u6587\u4e4b\u95f4\u9700\u8981\u6709\u4e00\u4e2a\u7a7a\u683c |\n| E103 | \u6bb5\u843d | \u9664\u4e86\u300c\uff05\u300d\u3001\u300c\u2103\u300d\u3001\u4ee5\u53ca\u500d\u6570\u5355\u4f4d\uff08\u5982 2x\u30013n\uff09\u4e4b\u5916\uff0c\u5176\u4f59\u6570\u5b57\u4e0e\u5355\u4f4d\u4e4b\u95f4\u9700\u8981\u52a0\u7a7a\u683c |\n| E104 | \u6bb5\u843d | \u4e66\u5199\u65f6\u62ec\u53f7\u4e2d\u5168\u4e3a\u6570\u5b57\uff0c\u5219\u62ec\u53f7\u7528\u534a\u89d2\u62ec\u53f7\u4e14\u9996\u62ec\u53f7\u524d\u8981\u7a7a\u4e00\u683c |\n| E201 | \u53e5\u5b50 | \u53ea\u6709\u4e2d\u6587\u6216\u4e2d\u82f1\u6587\u6df7\u6392\u4e2d\uff0c\u4e00\u5f8b\u4f7f\u7528\u4e2d\u6587\u5168\u89d2\u6807\u70b9 |\n| E202 | \u53e5\u5b50 | \u5982\u679c\u51fa\u73b0\u6574\u53e5\u82f1\u6587\uff0c\u5219\u5728\u8fd9\u53e5\u82f1\u6587\u4e2d\u4f7f\u7528\u82f1\u6587\u3001\u534a\u89d2\u6807\u70b9 |\n| E203 | \u6bb5\u843d | \u4e2d\u6587\u6807\u70b9\u4e0e\u5176\u4ed6\u5b57\u7b26\u95f4\u4e00\u5f8b\u4e0d\u52a0\u7a7a\u683c |\n| E204 | \u53e5\u5b50 | \u4e2d\u6587\u6587\u6848\u4e2d\u4f7f\u7528\u4e2d\u6587\u5f15\u53f7\u300c\u300d\u548c\u300e\u300f\uff0c\u5176\u4e2d\u300c\u300d\u4e3a\u5916\u5c42\u5f15\u53f7 |\n| E205 | \u6bb5\u843d | \u7701\u7565\u53f7\u8bf7\u4f7f\u7528\u300c\u2026\u2026\u300d\u6807\u51c6\u7528\u6cd5 |\n| E206 | \u6bb5\u843d | \u611f\u53f9\u53f7\u8bf7\u4f7f\u7528\u300c\uff01\u300d\u6807\u51c6\u7528\u6cd5 |\n| E207 | \u6bb5\u843d | \u8bf7\u52ff\u5728\u6587\u7ae0\u5185\u4f7f\u7528\u300c~\u300d |\n| E301 | \u6bb5\u843d | \u5e38\u7528\u540d\u8bcd\u9519\u8bef |\n\n\u8be6\u60c5\u89c1 [\u5199\u4f5c\u89c4\u8303\u548c\u683c\u5f0f\u89c4\u8303\uff0cDaoCloud \u6587\u6863](http://docs-static.daocloud.io/write-docs/format)\u3002", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "UNKNOWN", "keywords": null, "license": "UNKNOWN", "maintainer": null, "maintainer_email": null, "name": "zh_doclint", "package_url": "https://pypi.org/project/zh_doclint/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/zh_doclint/", "project_urls": { "Download": "UNKNOWN", "Homepage": "UNKNOWN" }, "release_url": "https://pypi.org/project/zh_doclint/0.1.2/", "requires_dist": null, "requires_python": null, "summary": "automated checker of chinese document.", "version": "0.1.2" }, "last_serial": 2332006, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "6d2e0b8d4d6ecbb815c6c26cea3ce00d", "sha256": "32501726f8666a4469052d0ef59f4b47718f71270bf582bcb73746092782b3d1" }, "downloads": -1, "filename": "zh_doclint-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "6d2e0b8d4d6ecbb815c6c26cea3ce00d", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 11913, "upload_time": "2016-09-05T17:17:25", "url": "https://files.pythonhosted.org/packages/12/0c/08bca2d960f480bb57d54d819df16a2edb15bfc4efa10da34585825e5d72/zh_doclint-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "df97f48460acafaa32d01ce664cff696", "sha256": "9c577e68aa3e0ce97fc7b19b6fc0a6b234fd8e78bbb1462e764ceb0449232125" }, "downloads": -1, "filename": "zh_doclint-0.1.0.tar.gz", "has_sig": false, "md5_digest": "df97f48460acafaa32d01ce664cff696", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11720, "upload_time": "2016-09-05T17:17:20", "url": "https://files.pythonhosted.org/packages/5e/91/5b6284dfb350452f24e748200a00c139aba45ce7cb494c34574a6756d3bf/zh_doclint-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "1589d033a8edf928a21e454de39b5c1b", "sha256": "d8069787ad6d0a44ff8d00193ad49c6aebcbf4acf906bdfc9eaa98306c11722a" }, "downloads": -1, "filename": "zh_doclint-0.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1589d033a8edf928a21e454de39b5c1b", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 17982, "upload_time": "2016-09-08T14:39:56", "url": "https://files.pythonhosted.org/packages/40/90/a0404e39260ca810e5381f6d9800dc46a74a2db85b22fcd31de1f553b3cd/zh_doclint-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4ad4a62bbd8ca86f8761decf6f6ecd19", "sha256": "08a1f5fdf75909fb9d76222458ef067e30911b9fb872d64fdc625ee5a18684fe" }, "downloads": -1, "filename": "zh_doclint-0.1.1.tar.gz", "has_sig": false, "md5_digest": "4ad4a62bbd8ca86f8761decf6f6ecd19", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14433, "upload_time": "2016-09-08T14:39:50", "url": "https://files.pythonhosted.org/packages/89/b2/ec2192e1053cb6b526009729f951a2ff318c11cc54e2d753380ff508a1c1/zh_doclint-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "95a1e16ee0d7c9832d0b1d5e6455a4a3", "sha256": "e295df143f2ff8c52eac39a7643fc4bb573c4b9d8fc78668da22cf67e7067e96" }, "downloads": -1, "filename": "zh_doclint-0.1.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "95a1e16ee0d7c9832d0b1d5e6455a4a3", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 18362, "upload_time": "2016-09-08T18:09:43", "url": "https://files.pythonhosted.org/packages/53/6d/e5fe0274f1cf93459e5b7b8a8efa00cd952fd3b9fc827ee8dbc1a5ff35c5/zh_doclint-0.1.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8de280ccb1154e4779f153f9cbf41e30", "sha256": "aed3f924b18e80853720675b2dfc4066425d185279b8d47bc8506c931dba5611" }, "downloads": -1, "filename": "zh_doclint-0.1.2.tar.gz", "has_sig": false, "md5_digest": "8de280ccb1154e4779f153f9cbf41e30", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14921, "upload_time": "2016-09-08T18:09:37", "url": "https://files.pythonhosted.org/packages/b3/6c/61ad2192487471554ef0a886d3932e8c0bb792f4b3465b65dd4d7063f7e4/zh_doclint-0.1.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "95a1e16ee0d7c9832d0b1d5e6455a4a3", "sha256": "e295df143f2ff8c52eac39a7643fc4bb573c4b9d8fc78668da22cf67e7067e96" }, "downloads": -1, "filename": "zh_doclint-0.1.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "95a1e16ee0d7c9832d0b1d5e6455a4a3", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 18362, "upload_time": "2016-09-08T18:09:43", "url": "https://files.pythonhosted.org/packages/53/6d/e5fe0274f1cf93459e5b7b8a8efa00cd952fd3b9fc827ee8dbc1a5ff35c5/zh_doclint-0.1.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8de280ccb1154e4779f153f9cbf41e30", "sha256": "aed3f924b18e80853720675b2dfc4066425d185279b8d47bc8506c931dba5611" }, "downloads": -1, "filename": "zh_doclint-0.1.2.tar.gz", "has_sig": false, "md5_digest": "8de280ccb1154e4779f153f9cbf41e30", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14921, "upload_time": "2016-09-08T18:09:37", "url": "https://files.pythonhosted.org/packages/b3/6c/61ad2192487471554ef0a886d3932e8c0bb792f4b3465b65dd4d7063f7e4/zh_doclint-0.1.2.tar.gz" } ] }