Skip to content

Update docs to 2021 edition, test#577

Merged
KodrAus merged 2 commits into
rust-lang:masterfrom
nyurik:fmt-docs
Nov 19, 2023
Merged

Update docs to 2021 edition, test#577
KodrAus merged 2 commits into
rust-lang:masterfrom
nyurik:fmt-docs

Conversation

@nyurik

@nyurik nyurik commented Aug 20, 2023

Copy link
Copy Markdown
Contributor
  • 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?

@Thomasdezeeuw Thomasdezeeuw left a comment

Copy link
Copy Markdown
Collaborator

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).

Comment thread src/lib.rs Outdated
//! ### Examples
//!
//! ```edition2018
//! ```edition2021

Copy link
Copy Markdown
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

nyurik commented Aug 20, 2023

Copy link
Copy Markdown
Contributor Author

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

@KodrAus

KodrAus commented Aug 20, 2023

Copy link
Copy Markdown
Contributor

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

@nyurik

nyurik commented Aug 28, 2023

Copy link
Copy Markdown
Contributor Author

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

nyurik commented Oct 21, 2023

Copy link
Copy Markdown
Contributor Author

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

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