Keep newlines between members with docs

[Shatur]

If --reorder-code is enabled, it removes newlines between members. This causes 2 inconveniences:

• Removes any member grouping.
• Members with documentation look a bit odd:

## Display name of the attachment.
@export var name: String
## Name of the attachment's author.
@export var author: String
## License under which the attachment is distributed.
@export var license: String

I'd suggest to preserve the newlines between members. And I'd probably always force a newline between members with docs 🤔

[NathanLovato]

Could you please show me the code you used as an input before running the formatter and the expected/desired output? So I can get a clear idea of what you're expecting.

[Shatur]

Sure!

Input:

class_name MakeHumanAttachment
extends Resource

@export var geometry: MakeHumanGeometry
@export var material: MakeHumanMaterial

@export var x_scale: MakeHumanScale
@export var y_scale: MakeHumanScale
@export var z_scale: MakeHumanScale

After running the formatter:

class_name MakeHumanAttachment
extends Resource

@export var geometry: MakeHumanGeometry
@export var material: MakeHumanMaterial
@export var x_scale: MakeHumanScale
@export var y_scale: MakeHumanScale
@export var z_scale: MakeHumanScale

But I'd expect the newline to be preserved (i.e. I'd expect the input to not change).

Another case are docs. For example:

class_name MakeHumanAttachment
extends Resource

## Display name of the attachment.
@export var name: String

## Name of the attachment's author.
@export var author: String

## License under which the attachment is distributed.
@export var license: String

Formatted like this:

class_name MakeHumanAttachment
extends Resource

## Display name of the attachment.
@export var name: String
## Name of the attachment's author.
@export var author: String
## License under which the attachment is distributed.
@export var license: String

For docs I'd probably even force the newline 🤔

[NathanLovato]

Thank you very much! These lines should definitely not be removed.

As for forcing blank lines around variable declarations with a docstring, I wouldn't do it for now because from the code I've seen in the community at large, a lot of people naturally use pretty tight grouping without blank lines. Everything that's not officially specified, like this suggestion, be up for a discussion with users. And if a fair number of people express that they prefer spacing between documented declarations, this can eventually become a default rule.

[Shatur]

Makes sense!