vikramrojo / fortune

🔮Fortune is your friendly CSS properties framework.
MIT License
16 stars 2 forks source link

Add inline documentation #37

Open zaydek-old opened 6 years ago

zaydek-old commented 6 years ago

If you've ever looked at the official implementation for the Go standard library, one interesting decision the Go team advocates for is inline documentation, that is documenting the nature of the code so that is can be learnable in its context. See for example here: https://golang.org/src/text/template/parse/parse.go?s=6091:6230#L218

I recommend doing the same for the start of repeating classes, e.g. class-1, class-2, ... so that users don't require further documentation.

vikramrojo commented 6 years ago

Had removed documentation until the framework was a bit more stable but a great reminder to reintroduce inline docs in variables & other css files.

vikramrojo commented 6 years ago

Requirement is to add sources where possible, eg. http://clrs.cc