How to write library docs | Iron review
Ғылым және технология
Hate watching videos? Check out the complementary article, which covers the same content: dev.to/zelenya/what-makes-lib...
Using most of the libraries for the first time usually sucks. But it doesn’t have to be this way. Iron is a specific library for a specific use case, but we can all learn from it.
💡 Useful links:
* Iron: github.com/Iltotore/iron
* Iron: iltotore.github.io/iron/docs/...
* Documentation system: documentation.divio.com/
#fp #docs #scala
Subscribe to Impure Pics: bit.ly/impure-youtube
More Impure Pics
🐣 / impurepics
📦 impurepics.com
👕 merch.impurepics.com
Functional Alphabet book
📗 Softcover: bit.ly/fp-abc-soft-cover
📘 Hardcover: bit.ly/fp-abc-hard-cover
Watch more Impure Pics
• Debunking Haskell Myth...
About Impure Pics
FP Advocat. Distilling functional programming for the good of all
Get in touch: zelenya.com
0:00 Intro
0:20 Initial impression
1:49 Great Expectations
3:04 Microsite
4:26 Reference, not reference
5:51 API reference
6:15 Putting it to work
7:56 Expected `shouldEqual` Actual
Пікірлер: 7
It would be amazing if Haddock could produce docs as nice as the ones produced by Scaladoc.
I'm glad you like the documentation! It was the first time I invested that much time in writing a good documentation and when watching your review, I caught an error on the "Getting Started" page 😅. Note: the microsite is entirely made using Scaladoc. It is possible to include static documentation since Scala 3.0 and it got a new look since 3.2 if I remember correctly.
@impurepics
Жыл бұрын
Oh, that's great; thank you 🙏
Not using Haskell? HERESY 🔥
@impurepics
Жыл бұрын
Using Haskell to talk about great docs? Well, this is a challenge 😅
@beauteetmusculation8191
Жыл бұрын
@@impurepics I completely agree. The documentation of Haskell is a shame. One of the most beautiful languages, one of the worst documentations. It's almost criminal.
@i-am-the-slime
Жыл бұрын
@@impurepics you could talk about pandoc though