JuliaLang/julia

help should indicate where things come from

Open

#18,745 opened on Sep 30, 2016

View on GitHub
 (22 comments) (4 reactions) (0 assignees)Julia (48,709 stars) (5,773 forks)batch import
Hacktoberfestdocsystemgood first issuehelp wanted

Description

Currently there's no indication in help output where a binding comes from and this information is fairly annoying to find.

Contributor guide

Tech stack
None
Domain
clidocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Julia programming basicsREPL usage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the REPL help system in Julia's base/REPL.jl to understand how help output is generated. Look for where binding names are printed and determine where to add source module or file information. Review the comments on issue #18745 for any suggested approaches or constraints. Since no PR is linked, this is open for implementation.