Matching Content in our Doctests

[henrifroese]

It would be great to have more friendly and funny doctest text content (instead of "Aha", "Text", ...). It's also nicer for users if the docstring examples are all similar.

One idea, for instance, is to use famous sentences said by movie Superheroes. Here are a few examples:

• I have the power!
• Flame on!
• HULK SMASH!
• Holy ____ Batman!
• I am the vengeance, I am the night, I am BATMAN!
• I am GROOT.
• I’m going ghost!
• I am the law!
• SPOOOON!!!

Just comment below if you would like to work on this. Goals would probably be:

• for all doctests outside of representation.py, change them to use some of the sentences from above
• for all doctests in representation.py (and maybe also in visualization.py), we purposely currently have doctests that give users nice results (e.g. for the clustering functions we have doctests that are easily separable into clusters so users understand our examples). We might need to add some more example sentences to the list above to create 2-3 "topics" in our pool of examples that the clustering functions will find
• as a last step, add this information to the CONTRIBUTING.md so other devs will know about it

[k0pernicus]

Hi @henrifroese, this could be a good first issue in order to contribute to TextHero and explore a bit more the package. I could work on it if nobody is working on.

[jbesomi]

Hi @k0pernicus, indeed this is a good first issue, and nobody is working on it right now. So yes, you can take over this issue if you wish 👍🏻