[#135] Add documentation about internal module structure #162
Conversation
src/Universum.hs
Outdated
| meaning or __theme__. Name of the module should give you hints regarding what | ||
| this module contains. Some /themes/ contains a lot of reexported stuff and a lot | ||
| of our own. To make it easier to maintain and understand such huge chunks of | ||
| functions, all reexported staff is moved into separate module with name |
src/Universum.hs
Outdated
| @ | ||
|
|
||
| This documentation section contains description of internal module structure to | ||
| help navigate between modules, search for interested functionality and |
There was a problem hiding this comment.
interested functionality -> interesting functionality/functionalities?
src/Universum.hs
Outdated
|
|
||
| Functions and types are distributed across multiple modules and grouped by | ||
| meaning or __theme__. Name of the module should give you hints regarding what | ||
| this module contains. Some /themes/ contains a lot of reexported stuff and a lot |
There was a problem hiding this comment.
"Some /themes/ contain a great amount of both reexported functions and functions of our own. To make it easier to understand these huge chunks of functions, ... "
README.md
Outdated
| @@ -122,6 +125,10 @@ If you're using [Emacs](https://www.gnu.org/software/emacs/), you can | |||
| [modify your configs](https://github.com/serokell/universum/issues/8#issuecomment-276444879) | |||
| a little bit if you don't want to type `import Universum` manually every time. | |||
|
|
|||
| If you want to get familiar with `universum` internal structure you can just | |||
| @@ -122,6 +125,10 @@ If you're using [Emacs](https://www.gnu.org/software/emacs/), you can | |||
| [modify your configs](https://github.com/serokell/universum/issues/8#issuecomment-276444879) | |||
There was a problem hiding this comment.
If you're using Emacs and don't want to type import Universum manually every time, you can modify your configs a little bit.
README.md
Outdated
| 2. `universum`-specific [HLint](http://hackage.haskell.org/package/hlint) rules: | ||
| [`.hlint.yaml`](https://github.com/serokell/universum/blob/master/.hlint.yaml) | ||
| 3. Focus on safety, convenience and efficiency. | ||
| 3. Very few LiquidHaskell properties. At least LiquidHaskell is on Travis CI and |
There was a problem hiding this comment.
"Only a few LiquidHaskell properties right now, but LiquidHaskell is on Travis CI and other properties are just waiting to be added!" ?
src/Universum.hs
Outdated
| functions, all reexported staff is moved into separate module with name | ||
| @Universum.SomeTheme.Reexport@ and our own functions and types are in | ||
| @Universum.SomeTheme.SomeName@. For example, see modules | ||
| "Universum.Container.Class" and "Universum.Container.Reexport". |
There was a problem hiding this comment.
Probably this will also look better in @@?
There was a problem hiding this comment.
Probably looks better... But it's too tedious to format every module like that... And we don't have best practices for formatting Haddock..
| * __"Universum.String"__: reexports from @text@ and @bytestring@ packages with | ||
| conversion functions between different textual types. | ||
| * __"Universum.TypeOps"__: convenient and fancy type-level operators. | ||
| * __"Universum.Unsafe"__: unsafe functions (produce 'error'). |
There was a problem hiding this comment.
Probably should mention that it's not in Universum module?
Resolves #135