Skip to content

Improved readability, grammar, as well as added docstrings for consistency #4267

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

NASAnerd05
Copy link

@NASAnerd05 NASAnerd05 commented Jun 5, 2025

…py readability and docstrings

Overview: What does this pull request change?

This PR includes:

  • Fixes for minor grammar mistakes in .rst files under docs/source
  • Docstrings added to classes that were previously missing them (for consistency)
  • Readability improvements to some existing docstrings
  • File-level docstrings added to a few .py files to help quickly identify their purpose

Motivation and Explanation: Why and how do your changes improve the library?

These changes improve the overall readability and consistency of the documentation and source files. While they don't affect functionality, they help make the codebase a little easier to navigate and understand — especially for new contributors or users exploring the internals.

Links to added or changed documentation pages

https://manimce--4267.org.readthedocs.build/en/4267/

Further Information and Comments

Thank you for the opportunity to contribute! Let me know if there's anything I should do differently, especially formatting-wise or regarding documentation style. I'm here to learn.

Reviewer Checklist

  • The PR title is descriptive enough for the changelog, and the PR is labeled correctly
  • If applicable: newly added non-private functions and classes have a docstring including a short summary and a PARAMETERS section
  • If applicable: newly added functions and classes are tested

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🆕 New
Development

Successfully merging this pull request may close these issues.

1 participant