Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
thombashi committed Jun 10, 2023
1 parent 8305360 commit 6b8c52b
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.rst
Expand Up @@ -30,15 +30,15 @@ Summary
:target: https://coveralls.io/github/thombashi/typepy?branch=master
:alt: Test coverage

.. image:: https://github.com/thombashi/typepy/actions/workflows/codeql-analysis.yml/badge.svg
:target: https://github.com/thombashi/typepy/actions/workflows/codeql-analysis.yml
.. image:: https://github.com/thombashi/typepy/actions/workflows/github-code-scanning/codeql/badge.svg
:target: https://github.com/thombashi/typepy/actions/workflows/github-code-scanning/codeql
:alt: CodeQL

Features
==========
- checking a value type
- validate a value for a type
- convert a value from a type to the other type
- convert a value from one type to the other type

The correspondence between Python types and ``typepy`` classes are as follows:

Expand Down Expand Up @@ -93,10 +93,10 @@ Installation: apt

Dependencies
============
- Python 3.6+
- Python 3.7+
- `Python package dependencies (automatically installed) <https://github.com/thombashi/typepy/network/dependencies>`__

Optioal dependencies
Optional dependencies
----------------------------------
These packages can be installed via ``pip install typepy[datetime]``:

Expand Down Expand Up @@ -176,7 +176,7 @@ force_convert
>>> try:
... Integer("abc").force_convert()
... except TypeConversionError as e:
... # force_convert() raised TypeConversionError when the value not convertible
... # force_convert() raised TypeConversionError when the value was not convertible
... print(e)
...
failed to force_convert to int: type=<class 'str'>
Expand All @@ -185,7 +185,7 @@ force_convert
For more information
--------------------------------------------
Type check/validate/convert results differed according to
``strict_level`` value which can pass to typepy classes constructors as an argument.
``strict_level`` value which can pass to typepy class constructors as an argument.
More information can be found in the
`API reference <https://typepy.rtfd.io/en/latest/pages/reference/index.html>`__.

Expand Down

0 comments on commit 6b8c52b

Please sign in to comment.