Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Documentation needs better explanations

See original GitHub issue

I went to one of the examples in the documentation link and saw this step:

txt_mov = txt_col.set_pos( lambda t: (max(w/30,int(w-0.5*w*t)),
                                  max(5*h/6,int(100*t))) )

I didn’t understand what was going on there and wanted to do a reverse animation, but the comment says just: “I am NOT explaining the formula, understands who can/want.”, which I don’t find helpful at all.

Issue Analytics

State:
Created 3 years ago
Comments:9

Top GitHub Comments

3reactions

tburrows13commented, May 14, 2020

I’ll leave it open until the original example is updated 😃

0reactions

filiptronicekcommented, May 14, 2020

Yes, thanks! Worked perfectly

Top Results From Across the Web

Why documentation matters, and why you should include it in ...

In this article, I'll argue why documenting your code will lead to becoming a better developer, and will contribute to being a great...

5 Tips for Improving Documentation | CloudApp Blog

But improving documentation is essential for any business looking to grow and achieve a high level of success. In this article, we'll cover...

The Importance of Documentation - Addiction Academy

Proper documentation can help the practitioner to recall those moments. ... or a better approach, a more successful course of treatment, ...

What is process documentation, and why do I need it? - Slack

Process documentation enables a smoother transition. Analysis. How can you know if a new method works better than the old if there isn't...

The four kinds of documentation, and why you need to ...

Nearly everyone agrees that good documentation is important to the success of software projects, and yet very few projects actually have good documentation....