Results for inventory-rake-tasks-yard

JavaScript client for graphql-ruby

Architect project resource enumeration utility

An javascript implementation of the Rapid Automated Keyword Extraction (RAKE) algorithm. Forked from https://github.com/sleepycat/rapid-automated-keyword-extraction

Common utility functions

Migrations tool for Postgresql DB

Offload tasks to a pool of workers on node.js and in the browser

Run an array of functions in parallel

MediaPipe Vision Tasks

Cloud Tasks API client for Node.js

Run an array of functions in parallel, but limit the number of tasks executing at the same time

List of ML tasks for huggingface.co/tasks

Transcend MCP Server — Data Inventory tools.

High-priority task queue for Node.js and browsers

Lint files staged by git

Runs a list of async tasks, passing the results of each into the next one

The MDN page inventory as a big JSON object.

Opt-in charters module for OTA, tour-operator, and DMC deployments. Models small-scale or specialized charter inventory that does not fit the cruise schema - per-suite flat pricing, whole-yacht charter under MYBA contract, and APA (Advance Provisioning Al

A command line interface for programmatic operations across Transcend.

Run promise-returning & async functions in series, each passing its result to the next

Run promise-returning & async functions concurrently with optional limited concurrency

Manage contextual information needed by (a)synchronous tasks without explicitly passing objects around

High-priority task queue for Node.js and browsers

generate TypeScript types from your Zod schema

A shim for the setImmediate efficient script yielding API

Inventory-Rake-Tasks-YARD Inventory-Rake-Tasks-YARD provides Rake¹ tasks for YARD² using your Inventory³. ¹ See http://rake.rubyforge.org/ ² See http://yardoc.org/ ³ See http://disu.se/software/inventory/ § Installation Install Inventory-Rake-Tasks-YARD with % gem install inventory-rake-tasks-yard § Usage Include the following code in your ‹Rakefile› (assuming that you’ve already set up Inventory-Rake¹: Inventory::Rake::Tasks.unless_installing_dependencies do require 'inventory-rake-tasks-yard-1.0' Inventory::Rake::Tasks::YARD.new end This’ll define the following tasks: = .yardopts (file). = Create .yardopts file; depends on the file defining this task and Rakefile. = html. = Generate documentation in HTML format for all lib files in the inventory; depends on .yardopts file. ‹Inventory::Rake::Tasks::YARD› takes a couple of options, but the ones you might want to adjust are = :options. = The options to pass to YARD; will be passed to `Shellwords.shelljoin`. = :globals. = The globals to pass to YARD. = :files. = The files to process; mainly used if you want to add additional files to process beyond the lib files in the inventory. The options passed to YARD will be augmented with any options you list in a file named ‹.yardopts.task›, where ‹task› is the name of the Rake task invoking YARD, for example, ‹.yardopts.html› for the default HTML-generating task. You can use this to add options that are local to your installation and should thus not be listed in the Rakefile itself. See the {API documentation}² for more information. ¹ See http://disu.se/software/inventory-rake/ ² See http://disu.se/software/inventory-rake-tasks-yard/api/Inventory/Rake/Tasks/YARD/ § Financing Currently, most of my time is spent at my day job and in my rather busy private life. Please motivate me to spend time on this piece of software by donating some of your money to this project. Yeah, I realize that requesting money to develop software is a bit, well, capitalistic of me. But please realize that I live in a capitalistic society and I need money to have other people give me the things that I need to continue living under the rules of said society. So, if you feel that this piece of software has helped you out enough to warrant a reward, please PayPal a donation to now@disu.se¹. Thanks! Your support won’t go unnoticed! ¹ Send a donation: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=now%40disu%2ese&item_name=Inventory-Rake-Tasks-YARD § Reporting Bugs Please report any bugs that you encounter to the {issue tracker}¹. ¹ See https://github.com/now/inventory-rake-tasks-yard/issues § Authors Nikolai Weibull wrote the code, the tests, the manual pages, and this README. § Licensing Inventory-Rake-Tasks-YARD is free software: you may redistribute it and/or modify it under the terms of the {GNU Lesser General Public License, version 3}¹ or later², as published by the {Free Software Foundation}³. ¹ See http://disu.se/licenses/lgpl-3.0/ ² See http://gnu.org/licenses/ ³ See http://fsf.org/

YARD-Value YARD-Value provides YARD¹ handlers for Value² objects. It’ll document whether the Value is Comparable and what attributes are used in such comparisons, its #initialize method, and its protected accessors. ¹ See http://yardoc.org/ ² See http://disu.se/software/value-1.0/ You add the documentation to the Module#Value invocation. Any ‹@param› tags are used both for the parameters to the #initialize method and for the protected accessors. This class Point # A point on a plane. # @param [Integer] x # @param [Integer] y Value :x, :y end generates documentation similar to class Point # A point on a plane. # @param [Integer] x # @param [Integer] y def initialize(x, y) end and this class Point # A point on a plane. # @param [Integer] x The x coordinate of the receiver # @param [Integer] y The y coordinate of the receiver Value :x, :y end generates documentation similar to class Point # A point on a plane. # @param [Integer] x # @param [Integer] y def initialize(x, y) protected # @return [Integer] The x coordinate of the receiver attr_reader :x # @return [Integer] The y coordinate of the receiver attr_reader :y end For comparable Values, a note is added about what attributes are used in the comparison. This class Point # A point on a plane. # @param [Integer] x # @param [Integer] y Value :x, :y, :comparable => true end is similar to class Point # A point on a plane. # @param [Integer] x # @param [Integer] y # @note Comparisons between instances are made between x and y. def initialize(x, y) end § Usage Add ‹--plugin yard-value-1.0› to your YARD command line. If you’re using Inventory-Rake-Tasks-YARD¹, add the following to your Rakefile: Inventory::Rake::Tasks::YARD.new do |t| t.options += %w'--plugin yard-value-1.0' end ¹ See http://disu.se/software/inventory-rake-tasks-yard-1.0/ § Financing Currently, most of my time is spent at my day job and in my rather busy private life. Please motivate me to spend time on this piece of software by donating some of your money to this project. Yeah, I realize that requesting money to develop software is a bit, well, capitalistic of me. But please realize that I live in a capitalistic society and I need money to have other people give me the things that I need to continue living under the rules of said society. So, if you feel that this piece of software has helped you out enough to warrant a reward, please PayPal a donation to now@disu.se¹. Thanks! Your support won’t go unnoticed! ¹ Send a donation: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=now@disu.se&item_name=YARD-Value § Reporting Bugs Please report any bugs that you encounter to the {issue tracker}¹. ¹ See https://github.com/now/yard-value/issues § Authors Nikolai Weibull wrote the code, the tests, and this README. § Licensing YARD-Value is free software: you may redistribute it and/or modify it under the terms of the {GNU Lesser General Public License, version 3}¹ or later², as published by the {Free Software Foundation}³. ¹ See http://disu.se/licenses/lgpl-3.0/ ² See http://gnu.org/licenses/ ³ See http://fsf.org/

YARD-Heuristics YARD-Heuristics heuristically determines types of parameters and return values for YARD documentation that doesn’t explicitly document it. This allows you to write documentation that isn’t adorned with “obvious” types, but still get that information into the output. It also lets you nice-looking references to parameters and have them be marked up appropriately in HTML output. § Heuristics The following sections list the various heuristics that YARD-Heuristics apply for determining types of parameters and return values. Note that for all heuristics, a type will only be added if none already exists. § Parameter Named “other” A parameter named “other” has the same type as the receiver. This turns class Point def ==(other) into class Point # @param [Point] other def ==(other) § Parameter Types Derived by Parameter Name Parameters to a method with names in the following table has the type listed on the same row. | Name | Type | |--------+-----------| | index | [Integer] | | object | [Object] | | range | [Range] | | string | [String] | Thus class Point def x_inside?(range) becomes class Point # @param [Range] range def x_inside?(range) § Block Parameters If the last parameter to a method’s name begins with ‘&’ it has the type [Proc]. class Method def initialize(&block) becomes class Method # @param [Block] block def initialize(&block) § Return Types by Method Name For the return type of a method with less than two ‹@return› tags, the method name is lookup up in the following table and has the type listed on the same row. For the “type” “self or type”, if a ‹@param› tag exists with the name “other”, the type of the receiver is used, otherwise “self” is used. For the “type” “type”, the type of the receiver is used. | Name | Type | |-----------------+----------------| | ‹<<› | self or type | | ‹>>› | self or type | | ‹==› | [Boolean] | | ‹===› | [Boolean] | | ‹=~› | [Boolean] | | ‹<=>› | [Integer, nil] | | ‹+› | type | | ‹-› | type | | ‹*› | type | | ‹/› | type | | each | [self] | | each_with_index | [self] | | hash | [Integer] | | inspect | [String] | | length | [Integer] | | size | [Integer] | | to_s | [String] | | to_str | [String] | Thus class Point def <<(other) becomes class Point # @return [Point] def <<(other) but class List def <<(item) becomes class List # @return [self] def <<(item) § Emphasizing Parameter Names When producing HTML output, any words in all uppercase, with a possible “th” suffix, that is also the name of a parameter, an ‹@option›, or a ‹@yieldparam›, will be downcased and emphasized with a class of “parameter”. In the following example, “OTHER” will be turned into ‹<em class="parameter">other</em>›: class Point # @return True if the receiver’s class and {#x} and {#y} `#==` those of # OTHER def ==(other) § Usage Add ‹--plugin yard-heuristics-1.0› to your YARD command line. If you’re using Inventory-Rake-Tasks-YARD¹, add the following to your Rakefile: Inventory::Rake::Tasks::YARD.new do |t| t.options += %w'--plugin yard-heuristics-1.0' end ¹ See http://disu.se/software/inventory-rake-tasks-yard/ § API There’s really not very much to the YARD-Heuristics API. What you can do is add (or modify) the types of parameters and return types of methods by adding (or modifying) entries in the Hash tables ‹YARDHeuristics::ParamTypes› and ‹YARDHeuristics::ReturnTypes› respectively. That’s about it. § Financing Currently, most of my time is spent at my day job and in my rather busy private life. Please motivate me to spend time on this piece of software by donating some of your money to this project. Yeah, I realize that requesting money to develop software is a bit, well, capitalistic of me. But please realize that I live in a capitalistic society and I need money to have other people give me the things that I need to continue living under the rules of said society. So, if you feel that this piece of software has helped you out enough to warrant a reward, please PayPal a donation to now@disu.se¹. Thanks! Your support won’t go unnoticed! ¹ Send a donation: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=now@disu.se&item_name=YARD-Heuristics § Reporting Bugs Please report any bugs that you encounter to the {issue tracker}¹. ¹ See https://github.com/now/yard-heuristics/issues § Authors Nikolai Weibull wrote the code, the tests, and this README. § Licensing YARD-Heuristics is free software: you may redistribute it and/or modify it under the terms of the {GNU Lesser General Public License, version 3}¹ or later², as published by the {Free Software Foundation}³. ¹ See http://disu.se/licenses/lgpl-3.0/ ² See http://gnu.org/licenses/ ³ See http://fsf.org/