doc: update config section

[FabianHofmann]

Update the documentation's config section. Pull out config comments to documentation.

[FabianHofmann]

@fneum @lisazeyen could one of you also have a look? In particular, at the documentation of the sector section at https://pypsa-eur--685.org.readthedocs.build/en/685/configuration.html#sector

[fneum]

Excellent! Super helpful!

I have made small adjustments here and there.

One thing to be careful about: When the documentation says percentage, I would put e.g. 20.7 for 20.7%, but in most cases the input requires 0.207. Maybe one could clarify this.

My other comment is stylistic. Could you check if it makes sense to adjust the column widths of the tables and give more width to the description?

[FabianHofmann]

Hey @virio-andreyana, there are still some unresolved issues. Would you look into them?

[virio-andreyana]

Okay, so the simple suggestion have been added. Now, only a few problem is left.

One thing to be careful about: When the documentation says percentage, I would put e.g. 20.7 for 20.7%, but in most cases the input requires 0.207. Maybe one could clarify this.

Hmm, I believe that the reader is smart enough to know how the meaning of the percentage works. So long as they see the config default value.

My other comment is stylistic. Could you check if it makes sense to adjust the column widths of the tables and give more width to the description?

I could try that, maybe by shortening the column for the attribute name, and values

[FabianHofmann]

thanks @virio-andreyana, perhaps we use share instead of percentage?

[FabianHofmann]

@fneum would you be fine with merging?

[fneum]

The CSVs now have quite a few empty lines. Might cause problems.

[fneum]

Otherwise, yes!

[FabianHofmann]

The CSVs now have quite a few empty lines. Might cause problems.

@fneum thanks for looking over
@virio-andreyana this seems to be the last remaining issue

[virio-andreyana]

The CSVs now have quite a few empty lines. Might cause problems.

Actually this is a dilemma. So what I wanted to achieve is to have all of the table to have the same spacing. But since some attribute have letters longer than 22 letters, the table shifts to the right. Making the room for the description smaller.

This is the case especially for sector.csv and industry.csv

[FabianHofmann]

The CSVs now have quite a few empty lines. Might cause problems.

Actually this is a dilemma. So what I wanted to achieve is to have all of the table to have the same spacing. But since some attribute have letters longer than 22 letters, the table shifts to the right. Making the room for the description smaller.

This is the case especially for sector.csv and industry.csv

Sound reasonable. Let's keep the extra lines, then. In the docs it looks good.