gnu-octave / gnu-octave/packages

Feature request - ability to search for individual function names within packages.

Open
#124 16 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
HTML
Stars
49
Forks
62
Avg merge
5h 49m
Merged PRs (30d)
24

Description

I know this is a non-trivial request, and may or may not already be part of the goal for this project, but I thought I'd open this as an issue to have a proper place for it.

Essentially, if this page is going to partly replace what octave-forge was used for (in terms of acting as a repository of packages), it would be useful to be able to search "inside" packages, for the presence (and possibly documentation) of provided functions.

One way this could be achieved is if package maintainers were asked to provide a list of provided functions (preferably with a link to documentation) with their packages, that could then be searched from the main search interface.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review how package metadata is represented and how the main search interface currently indexes packages. Define how maintainers would provide function names and documentation links, then make those details searchable within packages. Done means users can find individual functions and reach their documentation from search results.

Written by the indexing model from the issue text.

Assessment

Domain
search
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.