Position of the description field in the [package] section

1

I was searching for the recommended order of fields in the [package] section to make Carg.toml a bit more unified in crates developed by me.

The list in the cargo book looks like a good option, but 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 the recommendation is to put description to the very end of the [package] section. But I haven't seen many crates which follow it in practice. Some of the rust-lang crates follow it (e.g. flate2, libc, etc.), some don't (e.g. log, cc, std_detect, etc.). In my experience, it is even less frequent in the wider ecosystem.

Do you agree with the description recommendation? What are your thoughts on the recommended order of fields? Maybe the conventions page should cover all other field in addition to the 3 mentioned?

2

I agree with you that the recommendation does not seem good and I haven't seen it followed. I think it is probably intended to put the multi-line field after the one-line fields.