Skip to content

Commit

Permalink
Update Python version in docs (#240)
Browse files Browse the repository at this point in the history
* WIP: Prepare support for Python 3.11

* Fix python_requires

* Fix mypy

* Decrease maxmimum allowed

* Decrease maximum

* Decrease coverage threshold

* Add suppress_health_check to test_stratified_split_dataset

* Add suppress_health_check to test_stratified_split_dataset

* Bump Sphinx

* Bump Sphinx

* Add support to Python 3.10

* Update changelog and version

* Increase maxmimum allowed

* Lint fix

* Update changelog

* Update changelog and version

* Update python version from docs
  • Loading branch information
spinosaphb authored Aug 14, 2024
1 parent 3907847 commit 64bd8c7
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ In this session we'll guide you on how to contribute with the code. This is a gu
Code standards
--------------

This project is compatible only with python 3.6 to 3.9 and follows the `pep8 style <https://www.python.org/dev/peps/pep-0008/>`_
This project is compatible only with python 3.8 to 3.11 and follows the `pep8 style <https://www.python.org/dev/peps/pep-0008/>`_
And we use this `import formatting <https://google.github.io/styleguide/pyguide.html?showone=Imports_formatting#313-imports-formatting>`_

In order to check if your code is following our codestyle, you can run from the root directory of the repo the next commands:
Expand Down Expand Up @@ -153,7 +153,7 @@ Document your code
------------------

All methods should have type annotations, this allow us to know what that method expect as parameters, and what is the expected output.
You can learn more about it in `typing docs <https://docs.python.org/3.6/library/typing.html>`_
You can learn more about it in `typing docs <https://docs.python.org/3.8/library/typing.html>`_

To document your code you should add docstrings, all methods with docstring will appear in this documentation's api file.
If you created a new file, you may need to add it to the ``api.rst`` following the structure
Expand Down
2 changes: 1 addition & 1 deletion docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Getting started
Installation
------------

The fklearn library is compatible only with Python 3.6.2+.
The fklearn library is compatible only with Python 3.8+.
In order to install it using pip, run:

.. code-block:: bash
Expand Down

0 comments on commit 64bd8c7

Please sign in to comment.