bevy icon indicating copy to clipboard operation
bevy copied to clipboard

Move all crate attributes after the docs

Open tguichaoua opened this issue 2 years ago • 2 comments

Objective

  • Part of #9500
  • Follow up of #9558

Solution

  • Move crate attributes after the crate docs.

tguichaoua avatar Aug 24 '23 08:08 tguichaoua

I think having the attributes first make more sense, as they are targeted at contributors who will be the ones opening the files. Doc is targeted at users who will most of the time view them through another mean than opening the file

mockersf avatar Aug 24 '23 15:08 mockersf

Whether the attributes go before or after the docs, we should at least stick to a consistent style. IIRC, it currently differs depending on the crate which is ugly and confusing.

joseph-gio avatar Aug 26 '23 20:08 joseph-gio

I'd be happy to clean this one up, but I guess we might need more of a consensus? I reckon the point @mockersf makes is pretty valid (documentation in source files is for generators and tooling, not for ease of reading).

Could also close out bevyengine/bevy#9558 if we can get some agreement?

bas-ie avatar Sep 22 '24 06:09 bas-ie

I reckon the point @mockersf makes is pretty valid (documentation in source files is for generators and tooling, not for ease of reading).

I think with time I finally agree with this point. I'll close this PR and let you handle this.

tguichaoua avatar Sep 22 '24 09:09 tguichaoua