GithubHelp home page GithubHelp logo

Comments (3)

Pacman99 avatar Pacman99 commented on June 18, 2024 2

In my opinion, adding usage examples in digga/devos isn't really a good idea, since you would never interact with those exporters. The packages/overlays are just exported for you. And we already describe how that happens in devos docs.

Yeah maybe digga should just start adding usage examples like and any markdown documentation can go to devos.

from flake-utils-plus.

Pacman99 avatar Pacman99 commented on June 18, 2024

Currently in devos docs, we just explain the fact that your overlays and packages get exported by default. In pretty much all of the outputs docs we explain how things get exported.

And it makes much more sense to include usage examples in this repo. I think the 'how it works" info is already pretty well explained in the code. The weird comment indentations from me were because of nixpkgs-fmt flattening out all comments to one indent.

I can add some more comments and explanations on how to use them in https://github.com/gytis-ivaskevicius/flake-utils-plus/blob/staging/examples/exporters/flake.nix.

I don't mind adding a doc file for them or adding a section to the README, but that might be a bit of an overkill. The exporters are pretty simple to use, each just has one or two arguments and try their best to export as many things as possible.

from flake-utils-plus.

blaggacao avatar blaggacao commented on June 18, 2024

I agree, so in fup we do:

  • in-code docstrings
  • usage examples (these ones are missing here)

In devos, we also prefer to do proper (markdown) docs on a docs page.

In digga? — we might adopt the fup policy, since those repos are like siblings.

from flake-utils-plus.

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.