Git Product home page Git Product logo

Comments (2)

hsjobeki avatar hsjobeki commented on May 25, 2024 2

Excellent idea... We need a standard for many things in the comments.
If you're interested, I opened an RFC for the doc-comments in general -> NixOS/rfcs#145.

I'm looking forward that laying the foundation for further enhancements and rich features within doc-comments.
But before we can specify rich features we need to specify what a doc-comment is.

Currently, I expect the comments to be refactored to be doc-comments. From there, I think of something like tesh to test the examples in nixpkgs, which would be nice.

Once the format of doc-comments is specified, we can move forward to identify more rich features, such as examples that can be tested and types that everyone can use. So if you feel capable of it, you could write an RFC for that (based on RFC145, of course)

Unfortunately, Noogle cannot just change how nixpkgs currently is. If you want my opinion there:
-> is already a valid nix-token TOKEN_IMPLICATION. It could feel natural to use it here, although it is not used like that in Nix.

Suppose you want to test examples in your nix-codebase right away. You can fork the noogle/indexer (which outputs JSON) and feed it into something like Tesh (mentioned above).

from noogle.

hsjobeki avatar hsjobeki commented on May 25, 2024

Not planned. Noogle (for now) focuses only on documentation discovery. ;)

from noogle.

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.