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

Update docs to 2021 edition, test #577

Merged
merged 2 commits into from
Nov 19, 2023
Merged

Conversation

nyurik
Copy link
Contributor

@nyurik nyurik commented Aug 20, 2023

  • Inline format arg in documentation and a few call places
  • Add a unit test for inlined format args

I was surprised to discover that log crate has no edition value... Any reason to keep it at 2015?

Copy link
Collaborator

@Thomasdezeeuw Thomasdezeeuw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LTGTM. The reasons the docs to use edition 2015 is because we recently bumped our MSRV from 1.31 to 1.60 in 0.4.19 (#552).

src/lib.rs Outdated
@@ -48,24 +48,24 @@
//!
//! ### Examples
//!
//! ```edition2018
//! ```edition2021
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this can just be removed everywhere.

Suggested change
//! ```edition2021
//! ```

@nyurik
Copy link
Contributor Author

nyurik commented Aug 20, 2023

@Thomasdezeeuw I think they should be removed after #580, or else they will continue using 2015 which i think is a bit confusing

@KodrAus
Copy link
Contributor

KodrAus commented Aug 20, 2023

We can probably merge #580 first, and then circle back to this one.

@nyurik
Copy link
Contributor Author

nyurik commented Aug 28, 2023

Now that #580 is merged, I updated this PR to remove the editions and also add the 580's forgotten changelog entry. This one should be far easier to review :)

* Inline format arg in documentation and a few call places
* Add a unit test for inlined format args

I was surprised to discover that log crate has no edition value... Any reason to keep it at 2015?
@nyurik
Copy link
Contributor Author

nyurik commented Oct 21, 2023

@Thomasdezeeuw and @KodrAus a friendly ping. I just rebased it just to keep it current. Let me know if any changes are needed. Thx!

@KodrAus KodrAus merged commit cc2a3e0 into rust-lang:master Nov 19, 2023
14 checks passed
@nyurik nyurik deleted the fmt-docs branch November 20, 2023 00:22
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

Successfully merging this pull request may close these issues.

3 participants