Commit graph

6 commits

Author SHA1 Message Date
Darylgolden
6018ebf445 Revert "Merge branch 'main' of https://github.com/ManimCommunity/manim"
This reverts commit e7f9d23aa7, reversing
changes made to afe91d02b6.
2023-07-31 15:29:39 +08:00
NotWearingPants
95bca6f24b
Convert all types of parameters in docstrings to proper type annotations (#2988)
* Converted types in docstrings to type annotations

* `isort .`

* `black .`

* Additional docstrings type annotation fixes

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2022-11-10 07:17:21 +01:00
GameDungeon
daf23c9d10
Upgraded typehints (#2429)
* Future Annotations

* Delete template_twitter_post.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Apply suggestions from code review

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fixed broken RTD

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2022-01-20 12:26:21 +08:00
Anton Ballmaier
71b86d5dfa
Deprecation Decorators (#1404)
* test

* revert test changes

* finish draft implementation

* use @wrapss to remove docs problems

* reduce complexity and add doc deprecation

* Docs deprecated_params

* add decoratos to __init__

* Add decorators to documentation

* Finish detailed docs

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Apply suggestions from code review

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* change since/until/message param docs

* Mark get_callable_info and deprecation_text_component as private

* change how until is included in warning messages

* Add The to prameter descriptions

* is deprecated => has been deprecated

* Fix typo

* fix typo

* make params docs more readable

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* make redirections docs clearer

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fix typo

* fix typo

* fix typo

* is_are => has_have_been

* fix typo
(at this point I am questioning my ability to type prameter)

* update deprendency list

* order dependencies

* update examples

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix dependeny problem

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix duplicate problem

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* change decorator version

* updated lock file

* enhance function / method separation

* fix typo and double underscores

* rename message_ and replacement_

* Change warning to custom admonition

* remove [] as default parameters

* Remove "" around type

* fix typo

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix bug and move to inspect

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* doc string => docstring

* rename to deprecate

* change module docstring

* change to deprecation.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* some sugesstions

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* remove tests again

* Rename decorators.py to deprecate.py

* Update poetry.lock

* Test if deprecated class outputs the correct warning when used

* Rename deprecate to deprecation

* Fix typos

* Shorten conditional for msg

* Shorten conditional for since

* Shorten conditional for until

* Specify decorator arguments in test

* Add tests for since and until arguments

* Add test for since and until as arguments

* Add test for msg argument for class

* Add test for replacement argument for class

* Remove unneeded docstring in deprecated class

* Add test for deprecate method, no args

* Update docstring examples, move deprecated method outside class

* Add test for method in class, since and message args

* Add test for deprecating nested class

* Add test for deprecated method in nested class

* Test deprecation of nested function

* Test param deprecation, only params argument

* Test deprecation of single method param

* Rename single param test method name

* Fix deprecated_params docstring whitespace

* Test parameter redirection using tuple

* Update warning msgs in deprecated_params docstring

* Test parameter redirection using lambda function

* Test param redirection from many to one

* Test param redirection from one to many

* Update Top.foo to deprecate with message

* handle empty docstrings

* fix typo

* Update poetry.lock

* Update poetry.lock

* Deprecate ShowCreation using decorator to test the docs

* Test docstring for deprecated class

* Test docstring for Bar and Baz classes

* Test docstrings for the rest of the classes

* Test docstrings for Top methods

* Test docstrings for Top.Nested

* Test docstring for nested method

* Move deprecations to deprecation system

* Some more deprecations

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix version numbering inconsistancies

* Fix naming issue and MetaClass handling

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* restart CI

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: Ricky Chon <rickychon99@gmail.com>
Co-authored-by: Jan-Hendrik Müller <44469195+kolibril13@users.noreply.github.com>
2021-05-11 08:31:55 +02:00
Lionel Ray
39351b0202
Deprecation: Deprecated ShowCreation in favor of Create, added logger warning (#1124)
* Deprecated ShowCreation in favor of Create

* Fixed Black formatting and logger error

* Fixed relative import issue of logger

* Renamed CreateThen.. calls to previous names

* Fixed __all__ classes, fixed Create inheritance

* Update manim/animation/creation.py

Move logger warning to class initializer

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-03-23 16:13:59 +01:00
kolibril13
c05ee3e63c
Add examples to animation creation (#820)
* added creation animation

* added further animation

* added further animation + docstring template

* added further examples

* black

* one more update

* one more update

* one more update

* one more update

* one more update become

* hope that this will fix the build

* Apply suggestions from code review

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
Co-authored-by: Leo Torres <dleonardotn@gmail.com>

* updated templates

* small fix

* tests

* Apply suggestions from code review

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

* Update README.md

* merged master and typo in README.md

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
Co-authored-by: Leo Torres <dleonardotn@gmail.com>
2020-12-13 12:41:06 +01:00