Skip to content

MarkupText documentation: ul-tag should be changed to u-tag #3578

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

Closed
dandavison opened this issue Jan 15, 2024 · 2 comments · Fixed by #3745
Closed

MarkupText documentation: ul-tag should be changed to u-tag #3578

dandavison opened this issue Jan 15, 2024 · 2 comments · Fixed by #3745
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers issue:bug Something isn't working... For use in issues

Comments

@dandavison
Copy link
Contributor

Description of bug / unexpected behavior

This fails with ValueError: Unknown tag 'ul' on line 1 char 13

class MarkupExample(Scene):
    def construct(self):
        text = MarkupText("<ul>underlined</ul>")
        self.add(text)

Expected behavior

The docstring in the code indicates that it should produce underlined text:

- ``<ul>underline</ul>`` and ``<s>strike through</s>``

Note that this does work:

class MarkupExample(Scene):
    def construct(self):
        text = MarkupText('<span underline="single">underlined</span>')
        self.add(text)

System specifications

Manim Community v0.18.0
@uwezi
Copy link
Contributor

uwezi commented Jan 15, 2024

According to the Pango documentation (Pango is the external python library used here), it should be <u>...</u> which actually works

class MarkupExample(Scene):
    def construct(self):
        text = MarkupText("<u>underlined</u>")
        self.add(text)

https://docs.gtk.org/Pango/pango_markup.html

@uwezi
Copy link
Contributor

uwezi commented Jan 15, 2024

I have currently not set up a development branch again on my system - perhaps someone could quickly change the docstring? Line 889 in text_mobject.py - or rather line 897 in the current version on Github...

bild

@behackl behackl changed the title MarkupText ul tag does not work MarkupText documentation: ul-tag should be changed to u-tag Apr 20, 2024
@behackl behackl added documentation Improvements or additions to documentation good first issue Good for newcomers issue:bug Something isn't working... For use in issues labels Apr 20, 2024
@behackl behackl linked a pull request May 3, 2024 that will close this issue
6 tasks
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 good first issue Good for newcomers issue:bug Something isn't working... For use in issues
Projects
Status: 🆕 New
Development

Successfully merging a pull request may close this issue.

3 participants