Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Enable ANSI underline and inverse #696
You're going to have to give a lot more context than just saying it is a companion.
What is the purpose of this particular change? Please explain for those who will need to debug this in the future.
Note: you made an API breaking change, these are private methods but still… we try to avoid breaking APIs. Why does it need to be a positional argument?
You removed some documentation, is that documentation wrong? If it is, is it that the functionality should change or the documentation should change?
I am not a fan of the multiple lines of documentation that describe different pieces of functionality. Please break them up into individual lines for the individual code definitions.
@mpacer Thanks for the feedback!
I wanted to wait for feedback on the
Do you mean here in the Github comments or somewhere in the code docstring/comments?
The purpose is in the title of this PR.
Yes, since #259.
The functionality did change in #259 and the documentation should follow suit at some point.
I don't understand what you mean by that.
It would probably be best to get rid of most of the documentation, because it will not be as accurate as the code anyway, and it is very likely to fall out of sync (which it already did).
What about removing the description about the actual codes from the docstring and instead adding a few comments in the code where it is not obvious what certain codes do?
I forgot to address this:
It doesn't need to be a positional argument. I can make it a keyword argument if that's what you want, but it won't really help. The problem is that I'm calling the converter functions with one more argument in
But as you say, those are private functions. And I made them private intentionally. They are only there as an implementation detail for internal code re-use and they are not meant to be used externally.
In the future, we might even add more ANSI formatting, which will require further "breaking" changes.