Closed Bzero closed 1 month ago
Should we maybe add an additional >>>
here?
We can do that. Would you do it for all multi-line examples or only here with the use
statements?
I’m thinking all of the multi line examples to make it clear what is input and what is output.
Just be aware that there might be multi-line expressions which should not be formatted this way. So something like
fn f(x) =
x² + 1
should not be rendered as
>>> fn f(x) =
>>> x² + 1
because it needs to be entered as a single line.
The easiest (and possibly best?) option might be to get rid of the >>>
prompts all-together?
Yes, it would not be straight forward to distinguish those cases.
The easiest (and possibly best?) option might be to get rid of the
>>>
prompts all-together?
I think the >>>
prompts help to distinguish in and output in the examples, especially for the many one-liners we have so I would prefer to keep them. How about adding additional whitespace to the start of the lines to get a common indentation?
I think the
>>>
prompts help to distinguish in and output in the examples, especially for the many one-liners we have so I would prefer to keep them.
But we also have an indented equals sign for the outputs. So we would go from
>>> floor_in(m, 5.7 m)
= 5 m [Length]
to
floor_in(m, 5.7 m)
= 5 m [Length]
I don't really see a problem with that. I think I even prefer the latter one. Some users might not immediately understand that >>>
is supposed to be a prompt.
Yes that's true as well, I think it's fine to remove it then.
Resolves #602.