docs + refactor: Sphinx extensions added + Documentation updated + Docstrings updated. #8
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…cstrings + updated .flake8 to ignore error
…lake8 to ignore error
… docstrings * Updated docstrings for all methods of MArray. * Updated __init__ and class docstring of MArrayElement. * Renamed MArray.fetch_arr_label() to MArray.fetch_mob_arr_label(). * Placed play_anim and play_anim_args parameter at the end of MArray.append_elem().
* Created refsub.rst file that contains references to code elements. * Updated Animating Arrays guide with substitutions from refsub.rst.
drageelr
added a commit
that referenced
this pull request
Jan 8, 2023
* docs + refactor: Sphinx extensions added + Documentation updated + Docstrings updated. (#8) * docs: added intersphinx mapping + add_module_names config updated * docs: fixed references in Animating Arrays guide * docs: viewcode + napolean + autodoc_typehints sphinx extensions added * refactor: updated docstrings for MVariable * docs: changed func domain to meth in Animating Arrays guide * refactor: updated docstrings for MArrayElement * refactor: fixed Scene.play references in MVariable & MArrayElement docstrings + updated .flake8 to ignore error * refactor: docstrings for typing.Union fixed in MVariable + updated .flake8 to ignore error * refactor: updated docstrings for MArray + minor edit to MArrayElement docstrings * Updated docstrings for all methods of MArray. * Updated __init__ and class docstring of MArrayElement. * Renamed MArray.fetch_arr_label() to MArray.fetch_mob_arr_label(). * Placed play_anim and play_anim_args parameter at the end of MArray.append_elem(). * refactor: updated docstrings for MArrayElementComp & MArrayDirection * docs: created refsub.rst + added substitutions in Animating Arrays guide * Created refsub.rst file that contains references to code elements. * Updated Animating Arrays guide with substitutions from refsub.rst. * refactor: updated docstrings for MArrayPointer * feat: MArraySlidingWindow added + docs updated (#9) * feat: MArraySlidingWindow added * docs: MArraySlidingWindow docs added Example Gallery Animating Arrays Guide Reference Manual * docs: updated changelog for release 0.1.7
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview: What does this pull request change?
intersphinx: Configured forpython,manimandnumpy.napoleanviewcodesphinx_autodoc_typehintsrefsub.rstfor code element references.refsub.rst.MArrayElementMArrayMArrayPointerMVariableMArrayElementCompMArrayDirectionMotivation and Explanation: Why and how do your changes improve the library?
Further Information and Comments
Reviewer Checklist