Skip to content
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

Document the text attribute mappings in the Text initializer #4086

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

Conversation

harlanhaskins
Copy link

@harlanhaskins harlanhaskins commented Jan 2, 2025

Overview: What does this pull request change?

This adds documentation comments for the t2c, t2f, t2g, t2s, and t2w, and documents their long-form names. It also adds more specific type information to t2c and t2g.

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

These were undocumented and it was difficult to find out what to provide within them outside the bounds of the specific examples.

Links to added or changed documentation pages

https://manimce--4086.org.readthedocs.build/en/4086/reference/manim.mobject.text.text_mobject.Text.html#manim.mobject.text.text_mobject.Text

Further Information and Comments

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

These were undocumented and it was difficult to find out what to provide
within them outside the bounds of the specific examples.
Copy link
Member

@behackl behackl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you for your contribution!

@behackl behackl added the documentation Improvements or additions to documentation label Jan 20, 2025
@behackl behackl added this to the v0.19.1 milestone Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants