https://github.com/nkottary/help.jl

Query documentation from Julia prompt.
https://github.com/nkottary/help.jl

Last synced: 27 days ago
JSON representation

Query documentation from Julia prompt.

• Host: GitHub
• URL: https://github.com/nkottary/help.jl
• Owner: nkottary
• License: other
• Created: 2016-03-14T05:04:09.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-03-22T18:14:51.000Z (over 7 years ago)
• Last Synced: 2024-10-03T05:09:45.403Z (about 1 month ago)
• Language: Julia
• Size: 3.91 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Help.jl

Search through readme and documentation of packages and functions based on a query.  Unlike `apropos`, Help uses TF-IDF instead of sub-string search.

Run `update()` first to build the data needed for search.

## Example

```julia

julia> using Help

julia> help("Gray scale an image")

Help Results

---------

1. Images

2. ImageView

3. TestImages

4. ImageRegistration

5. SloanDigitalSkySurvey

julia> using MySQL

julia> help(MySQL, "get the last inserted id")

Help Results

---------

1. mysql_insert_id

julia> help(Base, "convert pointer to array")

Help Results

---------

1. pointer_to_array

2. oftype

3. bitpack

```