Git Product home page Git Product logo

hs-portray's People

Contributors

awpr avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

awpr isabella232

hs-portray's Issues

[Docs] Possible outdated documentation

We have identified 1 possible instance of outdated documentation:

About

This is part of a research project that aims to automatically detect outdated documentation in GitHub repositories. We are evaluating the validity of our approach by identifying instances of outdated documentation in real-world projects.

We hope that this research will be a step towards keeping documentation up-to-date. If this has been helpful, consider updating the documentation to keep it in sync with the source code. If this has not been helpful, consider updating this issue with an explanation, so that we can improve our approach. Thanks!

Create orphan instance packages for everything reasonably popular.

A pretty-printing ecosystem is only as useful as its collection of instances, and right now nothing outside of base, containers, and my own libraries has instances. The best I can do without convincing maintainers to buy into the idea is to provide orphans in appropriately-scoped packages.

Proposed setup

  • portray is still just the types, class, and instances for GHC-bundled libraries.
  • Several packages like portray-unordered-containers-orphans provide orphans for packages or small sets of related packages.
  • A portray-batteries package provides Data.Portray.Batteries with (all or a curated selection of) orphan instances and re-exports of some stuff (possibly even the prettyprinter integration).

This way, we get three main upsides:

  • portray is still a tiny dependency, so it's palatable for maintainers to provide instances.
  • It becomes convenient to adopt the library in an application codebase: just depend on portray-batteries.
  • Dependency-conscious application codebases can still benefit: depend on portray and whichever orphan packages you want.

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.