Giter Club home page Giter Club logo

Comments (4)

adituv avatar adituv commented on September 5, 2024

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.

mgsloan avatar mgsloan commented on September 5, 2024

@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:

2018-03-20_395x667_scrot

from rio.

lehins avatar lehins commented on September 5, 2024

@snoyberg Do you think that #163 addressed this issue or there is more improvements need to be done to the documentation organization.

from rio.

snoyberg avatar snoyberg commented on September 5, 2024

I think it addressed it, good catch. Closing.

from rio.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.