Allow docstring on the right of string fields

Internals & Design
1

In the era of super-wide screens, would allowing docstring on the right of struct fields be breaking ?

Compare this:

image
image788Ă—577 53.9 KB

To this:

image
image788Ă—577 68.8 KB

4 Likes
2

In my REPL, even the first alternative does not show in the docstring, should it?

1 Like
3

I don’t know on the REPL… the information should be “saved” as a docstring, then you can use packages like DocStringExtensions that extract this information and show it in the REPL (using ?StructName ) or in the rendered output of Documenter.jl

You made now me thinking that perhaps the fact to consider it as a docstring could be a contribution of the DocStringExtensions package… any-how, replacing the comment on the right (second screenshot) with a string generates a parsing error…

1 Like
4

as an ultra-wide screen fanboy myself I also would like such an option! Coincidentally, defining variables in ModelingToolkit does allow for such nice display:

ctbbl_parameters = @parameters begin
    (d = 0.0012), [bounds = (7.9e-4, 0.0021), description = "aerodynamic bulk drag/transfer coefficient"]
    (D = 3e-6), [description = "large scale divergence, 1/s"]
    (CO2 = 400.0), [description = "CO2 concentration, ppm"]
    (RHâ‚Š = 0.2), [description = "relative humidity above boundary layer"]
    (ECS_CO2 = 3.0), [description = "tropospheric warming per doubling of CO2 (global warming), K"]
    (δ_Δ₊T = 5.0), [description = "prescribed variability in temperature inversion (difference), K"]
    (Tâ‚Š_0 = 287.5), [description = "prescribed temperature above inversion without CO2 or cloud effects, K"]
    (T_FTR_0 = 293.0), [description = "prescribed temperature emission of free troposphere without CO2 effects, K"]
    (δ_FTR = 0.0), [description = "Environmental variability of T_FTR, K"]
1 Like