top | item 22894391

(no title)

shafte | 5 years ago

Perhaps you missed the "What's in it" section while skimming the readme? :)

>Because of folly's fairly flat structure, the best way to see what's in it is to look at the headers in top level folly/ directory. You can also check the docs folder for documentation, starting with the overview.

discuss

order

Traster|5 years ago

Ah, the old "Read the code" version of documentation. Guess what? That's not documentation. That's douchebag for "I didn't write documentation"

shafte|5 years ago

That doesn't seem very fair. They link a docs folder and an overview document, neither of which require that the user read code to get a good idea of the library's contents.

That said, the code is also reasonably well commented as well, for example: https://github.com/facebook/folly/blob/master/folly/Singleto.... So "read the code" is not terrible advice in this case either.