Comments (4)
Honestly I am considering whether RIO.Prelude.Reexports
should be removed entirely and its contents distributed across other modules. Whether or not something is just reexported from another package isn't really that important for an end-user to know, and having to search multiple places in the documentation for a function definition because you don't know whether it's a reexport is not great.
If we went this route, I think an organisation similar to base
would work well - reexports should go in modules like RIO.Text
etc already do, and then the most useful ones could then be exported from RIO
as well. This would probably be quite a lot of work though.
As for improving haddock, it already expands exported module documentation for modules that are not exported, so for everything other than UnliftIO
we could just add them to other-modules
.
from rio.
@adituv Agreed, Reexports is a bit weird, seems like it's mostly organization for development of RIO. PR #72 hides export of those modules. It's rather unorganized, though, and results in a funny mishmash of section headers:
from rio.
@snoyberg Do you think that #163 addressed this issue or there is more improvements need to be done to the documentation organization.
from rio.
I think it addressed it, good catch. Closing.
from rio.
Related Issues (20)
- documentation: it's not clear what the "source" argument to logInfoS and friends is for HOT 3
- missing a way to modify a logfunc to provide context HOT 5
- RIO.Process is running an "original" instead of a symbolic link HOT 7
- RIO.Process does not allow to Linux style operations on Windows and vice versa (or I didn't find the way to do it). HOT 1
- RIO module exports words :: String -> [String] HOT 1
- Lifting to Path HOT 1
- Multi-threaded logging HOT 2
- logOptionsHandle -> logSend is not thread-safe HOT 3
- A simple way to extend `SimpleApp`? HOT 3
- augmentPathMap assumes uppercase PATH on windows HOT 10
- Possible bug in RIO's MoandWriter (listen and pass) implementations HOT 2
- fold*1 variants for NonEmpty HOT 3
- Question: is there any chance to move logger to external library and expose some internals? HOT 3
- StrictData language extension HOT 1
- Explain how RIO.Vector relates to Data.Vector?
- Rio.Process shell (like proc) HOT 3
- HLint is triggered
- Unexpected omissions from submodule exports (e.g., RIO.Vector.iforM_) HOT 2
- How to improve integration with Haskeline or vty, using RIO with a terminal interface.
- Image in `README.md` broken HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from rio.