enable module support
Nobody has claimed this yet.
- Dominant language
- Scheme
- Stars
- 2
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Docs are currently all at the same level regardless of module.
Find a way to denote the module when documenting a function / variable / syntax.
Maybe: (doc-fun name docstring module)
Users could still say
(show-params "some-function")
when searching but the system searches through all modules looking for something with that name. We'd need to support multiple responses and give the user a list to choose from. E.G.:
(show-params "some-function")
; some-function found in 2 modules:
; 1) foo-module
; 2) bar-module
; enter the number of the item you wish to see the docs for.
Alternately the user could specify the module directly
(show-params "some-function" "foo-module")
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the implementations and tests for doc-fun and show-params, the entry points named in the issue. Determine how documented functions, variables, and syntax are stored and looked up, then define module association, direct module selection, and the multiple-match response. Done means documentation can distinguish identical names across modules while preserving name-only searches.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100