Giter Club home page Giter Club logo

tldr.jl's Introduction

TLDR

GitHub Workflow Status codecov GitHub Docs All Contributors

A package for fast help and snippets, for when you don't want to search the docs.

TLDR means Too Long, Didn't Read. This package is inspired by tldr-pages, but focused on Julia. They probably don't overlap.

Work in progress, let me know your opinion


I have created a proof-of-concept of the search online: https://abelsiqueira.github.io/TLDR.jl/

Here's a sneak peak:

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Abel Siqueira

πŸ’» πŸ”£

Kally Chung

πŸ”£

Utkarsh Rai

πŸ’»

Parth Pant

πŸ”£

VinΓ­cius Couto Tasso

πŸ’»

JoΓ£o Victor da Silva

πŸ”£

JoΓ£o Paludo

πŸ”£

Soham Biswas

πŸ”£

This project follows the all-contributors specification. Contributions of any kind welcome! See how to contribute.

tldr.jl's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

tldr.jl's Issues

TagBot trigger issue

This issue is used to trigger TagBot; feel free to unsubscribe.

If you haven't already, you should update your TagBot.yml to include issue comment triggers.
Please see this post on Discourse for instructions and more details.

If you'd like for me to do this for you, comment TagBot fix on this issue.
I'll open a PR within a few hours, please be patient!

No matching isless(::Array{String, 1}, ::String)

I get this error whenever i try to insert a new snippet

julia> package = "Crayons"
"Crayons"

julia> command = "r_fg = Crayon(foreground = :red)"
"r_fg = Crayon(foreground = :red)"

julia> tags = ["color"]
1-element Array{String,1}:
 "color"

julia> desc = "Create a crrayon with foreground color red"
"Create a crrayon with foreground color red"

julia> command = "r_fg = Crayon(foreground = :red, bold = true)"
"r_fg = Crayon(foreground = :red, bold = true)"

julia> new_snippet(package, command, desc, tags)
ERROR: MethodError: no method matching isless(::Array{String,1}, ::String)
Closest candidates are:
  isless(::Missing, ::Any) at missing.jl:87
  isless(::AbstractArray{T,1} where T, ::AbstractArray{T,1} where T) at abstractarray.jl:1857
  isless(::AbstractString, ::AbstractString) at strings/basic.jl:335
  ...
Stacktrace:
 [1] isless(::Tuple{Array{String,1},Int64,Int64}, ::Tuple{String,Int64,Int64}) at ./tuple.jl:367
 [2] lt(::Base.Order.ForwardOrdering, ::Tuple{Array{String,1},Int64,Int64}, ::Tuple{String,Int64,Int64}) at ./ordering.jl:57
 [3] lt(::Base.Order.By{Jet.var"#1#6"{Jet.var"#p#3",Jet.var"#o#4",Jet.var"#β„“#5"},Base.Order.ForwardOrdering}, ::OrderedCollections.OrderedDict{String,Any}, ::OrderedCollections.OrderedDict{String,Any}) at ./ordering.jl:59
 [4] sort!(::Array{Any,1}, ::Int64, ::Int64, ::Base.Sort.InsertionSortAlg, ::Base.Order.By{Jet.var"#1#6"{Jet.var"#p#3",Jet.var"#o#4",Jet.var"#β„“#5"},Base.Order.ForwardOrdering}) at ./sort.jl:498
 [5] sort!(::Array{Any,1}, ::Int64, ::Int64, ::Base.Sort.MergeSortAlg, ::Base.Order.By{Jet.var"#1#6"{Jet.var"#p#3",Jet.var"#o#4",Jet.var"#β„“#5"},Base.Order.ForwardOrdering}, ::Array{Any,1}) at ./sort.jl:583
 [6] sort!(::Array{Any,1}, ::Int64, ::Int64, ::Base.Sort.MergeSortAlg, ::Base.Order.By{Jet.var"#1#6"{Jet.var"#p#3",Jet.var"#o#4",Jet.var"#β„“#5"},Base.Order.ForwardOrdering}, ::Array{Any,1}) at ./sort.jl:589 (repeats 2 times)
 [7] sort! at ./sort.jl:582 [inlined]
 [8] sort! at ./sort.jl:673 [inlined]
 [9] #sort!#7 at ./sort.jl:733 [inlined]
 [10] reorder!() at /home/parthp/dev/Jet.jl/src/new.jl:76
 [11] new_entry(::String, ::String, ::String, ::String, ::Array{String,1}) at /home/parthp/dev/Jet.jl/src/new.jl:34
 [12] new_snippet(::String, ::String, ::String, ::Array{String,1}) at /home/parthp/dev/Jet.jl/src/new.jl:64
 [13] top-level scope at REPL[21]:1
 [14] run_repl(::REPL.AbstractREPL, ::Any) at /build/julia/src/julia-1.5.2/usr/share/julia/stdlib/v1.5/REPL/src/REPL.jl:288

Submit entries here

Write a comment on the form:

{
	"kind": "snippet or header",
	"description": "of the package, if the kind is 'header', or of the snippet otherwise"
	"package": "Empty if nothing needs to loaded",
	"command": "Empty if kind is 'header'",
	"tags": [
		"lower-case",
		"hyphen-separated"
	],
}

Create a web version

An interface passed to tldr> for instance, or maybe just an interface for viewing and creating entries.

Create new entries!

This is an endless job, but hopefully, you can help.

Here's a simple guide, but feel free to contact us.


Hacktoberfest

  • If there are many small Pull Requests, DigitalOcean may flag the repo as invalid.
  • So please submit a new entry with a few snippets per Pull Request.
  • Submitting only a new package header will be marked as invalid.
  • I will give preference to the first PR with at least 3 snippets for a given package.
  • But if you leave a comment below saying that you're working on a PR, I will give preference to your package within 1 hour of your comment - unless you don't make 3 snippets.

Formatting guidelines

These are modified as the package increases.

  • Description (except in headers): Use the imperative: "Get", "Do", "Solve", "Find";
  • Tags: Use lowercase and separate words by -: julia-snippets, linear-algebra;
  • Multiline snippets: Use \n to separate lines, i.e., add the line break \n between each line, and use two-space indentation. See cmd:cholesky for an example.

Simple contributing guide:

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.

Name

I usually prefer names starting with J, although TDLR may make more sense. Suggestions?

Dissemination of the tool and site

I have to prepare a minimum presentable version and announce the tool and ask for collaborators in a few places:

  • Julia discourse
  • Julia Brasil Telegram
  • Julia slack?
  • Julia Zulip?
  • Twitter
  • YouTube

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.