agda-stdlib icon indicating copy to clipboard operation
agda-stdlib copied to clipboard

Tidy up `README` imports #2280

Open jamesmckinna opened this issue 1 year ago • 4 comments

Brings the qualified imports into line with the emerging style-guidelines in line with #2280 .

Exceptions:

  • README.Data.List.Relation.Binary.Equality (which leaves holes open, moreover!?)
  • README.Data.List.Membership (not clear how best to rename the qualified import names)
  • README.Text.Tabular

jamesmckinna avatar Mar 08 '24 14:03 jamesmckinna

Re: @JacquesCarette 's comment about 'horizontal' vs. 'vertical' layout of Feijen-style reasoning...

Unfortunately, this is self-inflicted. Changing L to List as the qualified name made the lines really long, moreover for me at least, very hard to read. As an Algebra of Programming person, I'm used to the more generous/expensive 'vertical' style, not least because it permits attention to be focused/localised on the reasons for a rewrite in the one line, while also separating out the individual terms for similar consideration on their own line(s).

In a library module, I might not care, but in a README, given that it is affording documentary/tutorial description, I though the the extra space was not actually harmful, if anything an improvement. But YMMV... potato/aardappel ;-)

jamesmckinna avatar Mar 09 '24 08:03 jamesmckinna

Suggestion: create a local alias L for List for the scope of those proofs?

JacquesCarette avatar Mar 09 '24 13:03 JacquesCarette

Ach! That suggestion is tantamount to the original qualified importas L!?

jamesmckinna avatar Mar 09 '24 14:03 jamesmckinna

Local vs global...

JacquesCarette avatar Mar 09 '24 15:03 JacquesCarette