Skip to content

Commit

Permalink
Prepare release 2.1.6 (#68)
Browse files Browse the repository at this point in the history
* [UPD] docs, version

* [UPD] extra css

* [UPD] extra css

* fixup!

* fixup!fixup!

Co-authored-by: eisenmenger <[email protected]>
  • Loading branch information
FelixTheC and eisenmenger authored Jul 19, 2021
1 parent a557cd9 commit a49ddf2
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 5 deletions.
2 changes: 0 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ ___

### The Solution

![](https://media.giphy.com/media/L0Z4qwdwv62cn4haFp/giphy.gif)

I love Python and its freedom, but with the new option of adding _type hints_ I wanted to get rid of writing `if isinstance(value, whatever)` repeatedly in my programs, so I decided to create `strongtyping`...

My solution is a simple decorator called `@match_typing` which will check <b>at runtime</b> whether the parameters you provide to a function are valid, based on type hints you've already defined in the `def` line. Here are some examples:
Expand Down
3 changes: 2 additions & 1 deletion docs/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Release Notes

## Unreleased
## v2.1.6
- class decorator for docstrings from typing `class_docs_from_typing`
- beta feature FrozenType

## v2.1.5
- support for latest strongtyping-modules version (0.1.4)
Expand Down
3 changes: 3 additions & 0 deletions extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
span.caption-text {
color: #85caf2;
}
5 changes: 4 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,18 @@ nav:
- Home: 'index.md'
- User's guide:
- 'Installation': 'install.md'
- Reference:
- Runtime Typechecking:
- 'match_typing': 'match_typing.md'
- 'match_class_typing': 'match_class_typing.md'
- 'severity_level': 'severity_level.md'
- 'typed_namedtuple': 'namedtuple.md'
- 'getter / setter': 'setter.md'
- 'getter_setter': 'getter_setter.md'
- Additional Tools:
- 'docs_from_typing': 'docs_from_typing.md'
- 'rest_docs_from_typing': 'rest_docs_from_typing.md'
- 'numpy_docs_from_typing': 'numpy_docs_from_typing.md'
- Custom Types:
- 'Validator - type': 'validator.md'
- 'IterValidator - type': 'itervalidator.md'
- 'FrozenType': 'frozentype.md'
Expand All @@ -24,3 +26,4 @@ nav:
- 'Authors': 'authors.md'
- 'Special thanks': 'special_thanks.md'
theme: readthedocs
extra_css: [extra.css]
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

setup(
name="strongtyping",
version="2.1.5",
version="2.1.6",
description="Decorator which checks whether the function is called with the correct type of parameters",
long_description=README,
long_description_content_type="text/markdown",
Expand Down

0 comments on commit a49ddf2

Please sign in to comment.