Comments (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.
Not planned. Noogle (for now) focuses only on documentation discovery. ;)
from noogle.
Related Issues (20)
- Dependency Dashboard
- Document pkgs.writers.* HOT 2
- Builtin functions have invalid source code links HOT 2
- term argument in URL ignored if not surrounded by %22 HOT 3
- 404 for builtin.fetchurl HOT 1
- fetchFromGitHub wrong source location HOT 2
- autofocus input on landing page HOT 1
- use buttons instead of drop down for search filter selection HOT 4
- Changing to front page or function flashes website HOT 1
- deprecated notice HOT 1
- Some search result links broken HOT 1
- Handle mkOverride functions
- Light color scheme flashes before dark is applied HOT 1
- markdown code blocks in description don't keep indentation HOT 1
- Feature Request: Show Usage Example
- builtins.getFlake
- Machine-readable format HOT 4
- lib.pipe shows wrong documentation HOT 1
- FR: Result types HOT 1
- mem leak on main page? HOT 3
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 noogle.