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

Provide readable changelogs. #47207

Closed
bmusin opened this issue Jan 5, 2018 · 6 comments
Closed

Provide readable changelogs. #47207

bmusin opened this issue Jan 5, 2018 · 6 comments
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one.

Comments

@bmusin
Copy link
Contributor

bmusin commented Jan 5, 2018

Hi. Could you please provide more readable changelogs with use cases?

It's not easy to
extract relevant snippet or command, if any, from pull request discussion
Being overly technical and dry,
that discourages further adoption of otherwise, decent, compiler.

@LifeIsStrange
Copy link

+1

@kennytm kennytm added C-enhancement Category: An issue proposing an enhancement or a PR with one. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Jan 5, 2018
@durka
Copy link
Contributor

durka commented Jan 6, 2018

There are quite readable release notes and every major release comes with a blog post highlighting the major changes, usually with code examples.

@LifeIsStrange
Copy link

LifeIsStrange commented Jan 6, 2018

@durka Of course, but there are no releases notes for the beta and nightly releases, so the power users take the unstability and compatibility breakages of beta and nightly, without easily knowing what are the compatibility changes and without knowing what new features/improvments they can use...

Also, logically, a side effect of making those releases notes would be to grow the beta/nightly user base, and so virtuously, increasing the number of bug reports, and thus the stability.
I think that's an easy p-high candidate to do.

@bmusin
Copy link
Contributor Author

bmusin commented Jan 6, 2018

@durka, changelogs is nice, but the code examples are missing.
For instance, it's not easy to undertstand how to use
#45379 - impl FromIterator<()> for () - title isn't clear enough, how can one use it.

@jamessan
Copy link

There are quite readable release notes

Although, an outdated version is included in the release. The rust-1.23.0-src.tar.gz contains a RELEASES.md describing 1.22.0.

@steveklabnik
Copy link
Member

I'm going to give this a close. @bmusin , I can appreciate that a CHANGELOG would be nice, but we already do release notes, and a blog post. We don't have the capacity to commit to yet another list of changes to Rust.

I'm also not sure that a changelog would do what you want; code snippits are not a thing usually in the changelog.

If something is confusing to use, please open up one bug per thing; we can improve the docs individually, but a CHANGELOG isn't a commitment we can make at this time. Thanks for understanding.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one.
Projects
None yet
Development

No branches or pull requests

6 participants