JuliaLang/julia

add help builtins for special characters

Open

#33,666 opened on Oct 24, 2019

View on GitHub
 (7 comments) (4 reactions) (0 assignees)Julia (5,773 forks)batch import
docsgood first issuehelp wanted

Repository metrics

Stars
 (48,709 stars)
PR merge metrics
 (Avg merge 20d 6h) (157 merged PRs in 30d)

Description

Help currently had a list of keywords that are handled specially: https://github.com/JuliaLang/julia/blob/f8067172557e4967714e92450f27d74dbf959760/stdlib/REPL/src/docview.jl#L524-L529 (from #12438).

It would be good to handle characters which have special meaning:

  • $ for interpolation
  • @ for macro invocation
  • '' for character literals
  • " for string literals
  • [ for array expressions and comprehensions
  • ( for tuples
  • . for broadcasting
  • ``` for commands
  • ; other uses (as mentioned in punctuation.md)

cc: @charleskawczynski

Contributor guide

Research direction
Study the existing help builtins in stdlib/REPL/src/docview.jl and add entries for the remaining special characters: `.` for broadcasting, `\`` for commands, and `;` for other uses. Follow the pattern of already implemented characters.
Tech stack
None
Domain
developer experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJulia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75