Add "depending on what fits" after "either X or Y", or similar

haskell / pretty

Haskell Pretty-printer library

Other

69 stars 30 forks source link

Add "depending on what fits" after "either X or Y", or similar #48

Closed tomjaguarpaw closed 2 years ago

tomjaguarpaw commented 5 years ago

I was rather puzzled by these Haddock lines until I read the CHANGELOG and it was clear that it means "one or the other, depending on what fits". Could we please either

add "depending on what fits", or perhaps even better
use "X if it fits, Y otherwise"

Thanks

https://github.com/haskell/pretty/blob/e646037d433fd26374cbaa555ab79cc9569ff40c/src/Text/PrettyPrint/Annotated/HughesPJ.hs#L723
https://github.com/haskell/pretty/blob/e646037d433fd26374cbaa555ab79cc9569ff40c/src/Text/PrettyPrint/Annotated/HughesPJ.hs#L727
https://github.com/haskell/pretty/blob/e646037d433fd26374cbaa555ab79cc9569ff40c/src/Text/PrettyPrint/HughesPJ.hs#L390
https://github.com/haskell/pretty/blob/e646037d433fd26374cbaa555ab79cc9569ff40c/src/Text/PrettyPrint/HughesPJ.hs#L395

banacorn commented 3 years ago

fsep and fcat are confusing as well. Does anyone know what "Paragraph fill" mean in this context?

"Paragraph fill" version of sep.

"Paragraph fill" version of cat.