chapel icon indicating copy to clipboard operation
chapel copied to clipboard

[Feature Request]: Should chpldoc put each argument on its own line?

Open bradcray opened this issue 10 months ago • 2 comments

Summary of Feature

Description:

While reading through some documentation for library routines with many arguments today, as in BLAS:

Screen Shot 2024-04-22 at 3 41 48 PM

I found myself thinking that it would be nice if chpldoc, by default at least, put each argument onto its own line—i.e., forced a line break after each comma, probably with the closing paren and return type on a line of its own, and potentially the where clause on a line of its own as well.

Then I wondered whether, for routines with a per-argument description in their chpldocumentation, we could also put that documentation onto the same line as the argument itself.

Is this a blocking issue with no known work-arounds? no

bradcray avatar Apr 22 '24 22:04 bradcray