Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/junolab/docseeker.jl

Searching for documentation in Julia

https://github.com/junolab/docseeker.jl

Science Score: 10.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ○
    codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 6 committers (16.7%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (8.1%) to scientific vocabulary

Keywords

documentation julia

Keywords from Contributors

numerical julialang programming-language fluxes automatic-differentiation ode hybrid-differential-equations tabular-data dataframes data-frame
Last synced: 5 months ago · JSON representation

Repository

Searching for documentation in Julia

Basic Info
  • Host: GitHub
  • Owner: JunoLab
  • License: other
  • Language: Julia
  • Default Branch: master
  • Homepage:
  • Size: 102 KB
Statistics
  • Stars: 10
  • Watchers: 3
  • Forks: 11
  • Open Issues: 6
  • Releases: 0
Topics
documentation julia
Created over 8 years ago · Last pushed almost 5 years ago
Metadata Files
Readme License

README.md

DocSeeker

Build Status

DocSeeker.jl provides utilities for handling documentation in local (so far) packages.

Usage

The main entry point is searchdocs(needle::AbstractString): julia searchdocs("sin") will return a vector of tuples of scores and their corresponding match. Scores are numbers between 0 and 1, and represent the quality of a given match. Matches are DocObj, which accumulate lots of metadata about a binding (e.g. name, type, location etc.).

searchdocs takes three keyword arguments: - loaded::Bool = true will search only packages in the current session, while loaded = false will search in all locally installed packages (actually only those in Pkg.installed()). Requires a call to DocSeeker.createdocsdb() beforehand. - mod::Module = Main will filter out bindings that can't be reached from the given module -- by default every loaded package will be searched. - maxreturns::Int = DocSeeker.MAX_RETURN_SIZE = 20 will specify the maximum number of the results - exportedonly::Bool = false will search all names a module has, while exportedonly = true only takes exported names into consideration. - name_only::Bool = false will respect equalities between needle and both a binding's name and its doc text, while name_only = true only respects a equality to a binding's name.

Re-generation of the cache that powers the search in all installed packages can be triggered via DocSeeker.createdocsdb() (async, so no worries about killing you julia session). For now, there is no automatic re-generation, though that'll be implemented soon.

Owner

  • Name: Juno
  • Login: JunoLab
  • Kind: organization

Interesting Development Environment

GitHub Events

Total
Last Year

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 142
  • Total Committers: 6
  • Avg Commits per committer: 23.667
  • Development Distribution Score (DDS): 0.127
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Sebastian Pfitzner p****b@p****e 124
aviatesk a****k@g****m 14
Rafael Schouten r****n@g****m 1
Martijn Visser m****r@g****m 1
Julia TagBot 5****t 1
Filippo Vicentini f****i@g****m 1
Committer Domains (Top 20 + Academic)
physik.hu-berlin.de: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 10
  • Total pull requests: 14
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 22 days
  • Total issue authors: 6
  • Total pull request authors: 8
  • Average comments per issue: 2.5
  • Average comments per pull request: 1.43
  • Merged pull requests: 11
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • pfitzseb (4)
  • GregPlowman (2)
  • ghaspias (1)
  • zygmuntszpak (1)
  • NHDaly (1)
  • JuliaTagBot (1)
Pull Request Authors
  • aviatesk (4)
  • pfitzseb (4)
  • PhilipVinc (1)
  • ghaspias (1)
  • rafaqz (1)
  • SimonDanisch (1)
  • visr (1)
  • JuliaTagBot (1)
Top Labels
Issue Labels
enhancement (5) bug (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • julia 13 total
  • Total dependent packages: 1
  • Total dependent repositories: 0
  • Total versions: 8
juliahub.com: DocSeeker

Searching for documentation in Julia

  • Versions: 8
  • Dependent Packages: 1
  • Dependent Repositories: 0
  • Downloads: 13 Total
Rankings
Dependent repos count: 9.9%
Forks count: 12.5%
Average: 20.3%
Dependent packages count: 23.0%
Stargazers count: 35.6%
Last synced: 6 months ago