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

Undocumented breaking change to API broke several packages #77

Closed
John-Nagle opened this issue Jun 30, 2021 · 2 comments
Closed

Undocumented breaking change to API broke several packages #77

John-Nagle opened this issue Jun 30, 2021 · 2 comments

Comments

@John-Nagle
Copy link

John-Nagle commented Jun 30, 2021

pub fn new(
    log_level: LevelFilter,
    config: Config,
    mode: TerminalMode,
    color_choice: ColorChoice // Was this breaking change really necessary?
) -> Box<TermLogger>

I've spent the last two hours cleaning up the damage from that undocumented change.

@Drakulix
Copy link
Owner

I am sorry, but the CHANGELOG documents that 0.10 added more color customization. And you can check the docs, so what exactly would you have wished for?

Additionally simplelog does not frequently need any bugfixes and I am willing to backport anything significant to earlier versions, so nothing forces you to update to 0.10 (which is a new major release according to semver), if this causes trouble for you.

Debating whenever a change is necessary or not, does happen on this repository and you are welcome to participate, if you are a user of simplelog. The PR in question had a clear line of reasoning and added just one parameter to a constructor of one particular logger, which I expected to be called at most once in most repositories. While I try to keep the simplelog api stable, it is not set in stone (as shown by the 0.* versioning) and this seemed reasonable.

Could you elaborate, how this change took you two hours, so I can get a better understanding, why this was so troublesome to you and how I could better handle these cases in the future?

@Drakulix
Copy link
Owner

Since this went unanswered by more then a week and I am not sure, what kind of action I could take to address this, I am going to close this issue. Feel free to comment/reopen, if you have any suggestions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants