Giter Club home page Giter Club logo

jet.jl's Introduction

Jet

A package for fast help and snippets.

Travis CI Coveralls GitHub

Work in progress, let me know your opinion

julia> using Jet
julia> jet_repl()
julia> # Press }
jet>

Can also be used with jet(str) or jet"str".

Actions

jet> pkg:something

Returns all snippets associated with package something.

jet> pkg:DataFrames
DataFrames

Tools for working with tabular data.

- Create a new DataFrame by passing the column headers and contents
  `df = DataFrame(A = 1:3, B = [:odd, :even, :odd])`

Instead of pkg, package can also be used.

jet> cmd:something

jet> cmd:chol
- Solve a linear system `Ax = b` using the Cholesky factorization
  `F = cholesky(A)
  F \ b`

Instead of cmd, command or snippet can also be used. The argument can also be ignored.

jet> ?

Same as pkg:Jet.

jet> cmd:?
Jet

A package for fast help and snippets.

- Enter `jet>` mode.
  `}`

- Search for commands and packages related to the `keyword`.
  `jet"keyword"`

Contributing

The main need of the package right now is to create a useful database. For that, we have created a couple of commands:

new_pkg(pkg, description, tags)

Create a new entry for pkg using the description and some tags.

new_snippet([pkg=""], cmd, description, tags)

Create a new entry (that can be associated to a pkg) for a snippet cmd.

Short guide

  • Fork this repo
  • Clone your repo, create a branch for your contribution(s)
  • Go inside, run julia --project
  • Instantiate the project: ] becomes pkg>, then pkg> instantiate
  • using Jet
  • Use new_pkg or new_snippet
  • Commit with a message like "New package: ..." or "New snippet for how to ..."
  • Push to your repo, and create a PR to our main branch

You can watch a asciinema recording below (But I forgot to commit):

asciicast

Note: We use rebase and squash merges, so fetch this repo from time to time and update your main branch related to this one. Always branch from main.

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.