search

rust-itertools / itertools

Extra iterator adaptors, iterator methods, free functions, and macros.
https://docs.rs/itertools/
Apache License 2.0
2.71k stars 309 forks source link

Remove badges in README.md #890

Closed Philippe-Cholet closed 7 months ago

Philippe-Cholet commented 7 months ago

I might have been overzealous on the badges here but I think it's nice, especially the MSRV one that does not need manual updates.

Rendered badges [![Documentation](https://docs.rs/itertools/badge.svg)](https://docs.rs/itertools) [![crates.io](https://img.shields.io/crates/v/itertools.svg)](https://crates.io/crates/itertools) [![MSRV](https://img.shields.io/crates/msrv/itertools "Minimum Supported Rust Version")](https://github.com/rust-itertools/itertools/blob/master/Cargo.toml) [![License](https://img.shields.io/crates/l/itertools.svg)](https://github.com/rust-itertools/itertools) [![Build Status](https://github.com/rust-itertools/itertools/actions/workflows/ci.yml/badge.svg)](https://github.com/rust-itertools/itertools/actions) [![Code Coverage](https://img.shields.io/codecov/c/github/rust-itertools/itertools)](https://codecov.io/github/rust-itertools/itertools) [![Total Downloads](https://img.shields.io/crates/d/itertools.svg)](https://crates.io/crates/itertools) [![Contributors](https://img.shields.io/github/contributors/rust-itertools/itertools)](https://github.com/rust-itertools/itertools/graphs/contributors)
Philippe-Cholet commented 7 months ago

Well this is quite argumented and I can agree.

About Documentation (which replaces a sentence, same link), I guess we can say the end user does not care that the "docs are passing" as long as he has the link to it (and that it works, which is done in CI).

So remove the two badges instead?

Philippe-Cholet commented 7 months ago

@jswrenn phimuemue liked your comment and my reponse on the "docs" badge so I assume he agrees. I therefore removed all badges instead. For me, it was instructive about how to create badges, and why it might not be a good idea. You can merge or close this as you see fit.

Philippe-Cholet commented 7 months ago

@jswrenn Because this is markdown only, according to your https://github.com/rust-itertools/itertools/pull/767#issuecomment-1932290547, you have to bypass branch protections to merge this.