Canonical order for the `[package]` section fields?

[newpavlov]

Our crates do not have a unified order of [package] fields which makes mass edits somewhat inconvinient and makes it a bit harder to compare Cargo.toml files between each other.

The Cargo.toml conventions state the following:

Put the [package] section at the top of the file; put the name and version keys in that order at the top of that section, followed by the remaining keys other than description in order, followed by the description at the end of that section.

So it has a recommendation only for name, version, and description fields. Notably, we (and AFAIK most other developers) do not follow the description field recommendation.

I think it's worth to develop our own convention for the order of all fields.

One potential option is to use the order specified in the cargo book.

[tarcieri]

The order in the cargo book sounds fine to me

[newpavlov]

Do you mean as-is or with the description field moved to the very end?

[tarcieri]

If the convention is to put description at the end (I hadn’t seen that before) then we should do it

[newpavlov]

I asked about it on URLO: https://users.rust-lang.org/t/126175

[newpavlov]

Ok, let's use the cargo book order with description moved to the very end.

I guess the rationale for this is to keep other fields on the same line even in the presence of a multi-line description.