Fix two typos in README.md

dhall-lang / dhall-to-cabal

Compile Dhall expressions to Cabal files

MIT License

100 stars 19 forks source link

Fix two typos in README.md #109

Closed toonn closed 6 years ago

toonn commented 6 years ago

trasforming -> transforming lanugage -> language

I noticed these two typos while going through the readme. Two other things I noticed:

Consider using // instead of double solidus ⫽, apparently it's a fairly rare symbol, I had to install ttf-junicode ("A font for medievalists.") to view it and I have many fonts installed (I used the wikipedia language sidebar as a unicode coverage test starting with ttf-dejavu).
The blockquotes in the markdown don't seem to render on hackage. Maybe switch to multiline literal blocks?
```
Like
this.
```

toonn commented 6 years ago

Also, consider calling the package dhall-cabal maybe I'm being pedantic but it seems like it's the convention and this being bidirectional makes the "to" seem out of place.

ocharles commented 6 years ago

Thanks for the typo fixes!

Consider using // instead of double solidus ⫽, apparently it's a fairly rare symbol, I had to install ttf-junicode ("A font for medievalists.") to view it and I have many fonts installed (I used the wikipedia language sidebar as a unicode coverage test starting with ttf-dejavu).

This isn't really within my control - this is a syntactic construct in the Dhall language itself.

The blockquotes in the markdown don't seem to render on hackage. Maybe switch to multiline literal blocks?

This is actually a Hackage bug. It seems that it is a <blockquote> element, the CSS is just lacking.

toonn commented 6 years ago

Dhall supports both ⫽ and //. It supports ascii variants of most if not all constructs, lambdas can be written both λ(x : Text) -> x and \(x : Text) -> x for example. This remark only applies to public facing documentation btw, it's not as good an impression when people take a look at something and � characters show up.

Yes it is a feature lacking from hackage, I was actually going to open a bug report on this, thanks for reminding me. Opened haskell/hackage-server#775.

toonn commented 6 years ago

Just wanted to mention that my PR adding block quote styling was accepted: https://github.com/haskell/hackage-server/pull/776

toonn commented 5 years ago

🎉 The fix is finally live on hackage! : )