search

com-lihaoyi / os-lib

OS-Lib is a simple, flexible, high-performance Scala interface to common OS filesystem and subprocess APIs
Other
672 stars 63 forks source link

Fixing the ==> symbols in the readme docs #251

Closed rokkian closed 1 week ago

rokkian commented 6 months ago

As a beginner Scala developer I got confused by the ==> used in the cookbook examples in the README.md. So to improve readability commented such symbols and values.

lefou commented 6 months ago

IIRC, the ==> is defined in utest and stands for an equals assertion. Maybe, we could make the documentation executable and run it in CI?

rokkian commented 6 months ago

Okay, I didn't know about the utest semantics for "==>". I assumed it was bare markdown code, not tested. The PR can be deleted :)

Il dom 25 feb 2024, 18:37 Tobias Roeser @.***> ha scritto:

IIRC, the ==> is defined in utest and stands for an equals assertion. Maybe, we could make the documentation executable and run it in CI?

— Reply to this email directly, view it on GitHub https://github.com/com-lihaoyi/os-lib/pull/251#issuecomment-1963009186, or unsubscribe https://github.com/notifications/unsubscribe-auth/AITWJJOUOBPWKMHUJXUSEDLYVNZFVAVCNFSM6AAAAABDZAACNOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNRTGAYDSMJYGY . You are receiving this because you authored the thread.Message ID: @.***>