Commit 14110e39 authored by Nikita Titov's avatar Nikita Titov Committed by Qiwei Ye
Browse files

[docs] actualized PEP 8 description and links to PyPI (#1384)

* actualized pep8 ignored codes and fixed PEP 8 spelling

* actualized PyPI links
parent a0c69417
...@@ -6,10 +6,10 @@ LightGBM, Light Gradient Boosting Machine ...@@ -6,10 +6,10 @@ LightGBM, Light Gradient Boosting Machine
[![Documentation Status](https://readthedocs.org/projects/lightgbm/badge/?version=latest)](https://lightgbm.readthedocs.io/) [![Documentation Status](https://readthedocs.org/projects/lightgbm/badge/?version=latest)](https://lightgbm.readthedocs.io/)
[![GitHub Issues](https://img.shields.io/github/issues/Microsoft/LightGBM.svg)](https://github.com/Microsoft/LightGBM/issues) [![GitHub Issues](https://img.shields.io/github/issues/Microsoft/LightGBM.svg)](https://github.com/Microsoft/LightGBM/issues)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Microsoft/LightGBM/blob/master/LICENSE) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Microsoft/LightGBM/blob/master/LICENSE)
[![Python Versions](https://img.shields.io/pypi/pyversions/lightgbm.svg)](https://pypi.python.org/pypi/lightgbm) [![Python Versions](https://img.shields.io/pypi/pyversions/lightgbm.svg)](https://pypi.org/project/lightgbm)
[![PyPI Version](https://img.shields.io/pypi/v/lightgbm.svg)](https://pypi.python.org/pypi/lightgbm) [![PyPI Version](https://img.shields.io/pypi/v/lightgbm.svg)](https://pypi.org/project/lightgbm)
[![Join the chat at https://gitter.im/Microsoft/LightGBM](https://badges.gitter.im/Microsoft/LightGBM.svg)](https://gitter.im/Microsoft/LightGBM?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Join the chat at https://gitter.im/Microsoft/LightGBM](https://badges.gitter.im/Microsoft/LightGBM.svg)](https://gitter.im/Microsoft/LightGBM?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Slack](https://lightgbm-slack-autojoin.herokuapp.com/badge.svg)](https://lightgbm-slack-autojoin.herokuapp.com/) [![Slack](https://lightgbm-slack-autojoin.herokuapp.com/badge.svg)](https://lightgbm-slack-autojoin.herokuapp.com)
LightGBM is a gradient boosting framework that uses tree based learning algorithms. It is designed to be distributed and efficient with the following advantages: LightGBM is a gradient boosting framework that uses tree based learning algorithms. It is designed to be distributed and efficient with the following advantages:
...@@ -30,7 +30,7 @@ News ...@@ -30,7 +30,7 @@ News
07/13/2017 : [Gitter](https://gitter.im/Microsoft/LightGBM) is available. 07/13/2017 : [Gitter](https://gitter.im/Microsoft/LightGBM) is available.
06/20/2017 : Python-package is on [PyPI](https://pypi.python.org/pypi/lightgbm) now. 06/20/2017 : Python-package is on [PyPI](https://pypi.org/project/lightgbm) now.
06/09/2017 : [LightGBM Slack team](https://lightgbm.slack.com) is available. 06/09/2017 : [LightGBM Slack team](https://lightgbm.slack.com) is available.
......
...@@ -9,13 +9,13 @@ Installation ...@@ -9,13 +9,13 @@ Installation
Preparation Preparation
''''''''''' '''''''''''
`setuptools <https://pypi.python.org/pypi/setuptools>`_ is needed. `setuptools <https://pypi.org/project/setuptools>`_ is needed.
For macOS users, gcc with OpenMP support must be installed first. Refer to `Installation Guide <https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#macos>`__ for installing gcc with OpenMP support. For macOS users, gcc with OpenMP support must be installed first. Refer to `Installation Guide <https://github.com/Microsoft/LightGBM/blob/master/docs/Installation-Guide.rst#macos>`__ for installing gcc with OpenMP support.
Note: 32-bit Python is not supported. Please install 64-bit version. Note: 32-bit Python is not supported. Please install 64-bit version.
Install from `PyPI <https://pypi.python.org/pypi/lightgbm>`_ Using ``pip`` Install from `PyPI <https://pypi.org/project/lightgbm>`_ Using ``pip``
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
For Windows users, `VC runtime <https://go.microsoft.com/fwlink/?LinkId=746572>`_ is needed if Visual Studio (2015 or 2017) is not installed. For Windows users, `VC runtime <https://go.microsoft.com/fwlink/?LinkId=746572>`_ is needed if Visual Studio (2015 or 2017) is not installed.
...@@ -141,9 +141,9 @@ Refer to `FAQ <https://github.com/Microsoft/LightGBM/tree/master/docs/FAQ.rst>`_ ...@@ -141,9 +141,9 @@ Refer to `FAQ <https://github.com/Microsoft/LightGBM/tree/master/docs/FAQ.rst>`_
Developments Developments
------------ ------------
The code style of Python-package follows `pep8 <https://www.python.org/dev/peps/pep-0008/>`_. If you would like to make a contribution and not familiar with pep-8, please check the pep8 style guide first. Otherwise, the check won't pass. You should be careful about: The code style of Python-package follows `PEP 8 <https://www.python.org/dev/peps/pep-0008/>`_. If you would like to make a contribution and not familiar with PEP 8, please check the PEP 8 style guide first. Otherwise, the check won't pass. You should be careful about:
- E1 Indentation (check pep8 link above) - E1 Indentation (check PEP 8 link above)
- E202 whitespace before and after brackets - E202 whitespace before and after brackets
- E225 missing whitespace around operator - E225 missing whitespace around operator
- E226 missing whitespace around arithmetic operator - E226 missing whitespace around arithmetic operator
...@@ -151,11 +151,11 @@ The code style of Python-package follows `pep8 <https://www.python.org/dev/peps/ ...@@ -151,11 +151,11 @@ The code style of Python-package follows `pep8 <https://www.python.org/dev/peps/
- E301 expected 1 blank line in front of and at the end of a method - E301 expected 1 blank line in front of and at the end of a method
- E302 expected 2 blank lines in front of and at the end of a function or a class - E302 expected 2 blank lines in front of and at the end of a function or a class
E501 can be ignored (line too long). E501 (line too long) and W503 (line break occurred before a binary operator) can be ignored.
.. |License| image:: https://img.shields.io/badge/license-MIT-blue.svg .. |License| image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://github.com/Microsoft/LightGBM/blob/master/LICENSE :target: https://github.com/Microsoft/LightGBM/blob/master/LICENSE
.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/lightgbm.svg .. |Python Versions| image:: https://img.shields.io/pypi/pyversions/lightgbm.svg
:target: https://pypi.python.org/pypi/lightgbm :target: https://pypi.org/project/lightgbm
.. |PyPI Version| image:: https://img.shields.io/pypi/v/lightgbm.svg .. |PyPI Version| image:: https://img.shields.io/pypi/v/lightgbm.svg
:target: https://pypi.python.org/pypi/lightgbm :target: https://pypi.org/project/lightgbm
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment