JuliaLang/julia

add help builtins for special characters

Open

#33.666 geöffnet am 24. Okt. 2019

Auf GitHub ansehen
 (7 Kommentare) (4 Reaktionen) (0 zugewiesene Personen)Julia (5.773 Forks)batch import
docsgood first issuehelp wanted

Repository-Metriken

Stars
 (48.709 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 20T 6h) (157 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Studiere die vorhandenen Hilfe Builtins in stdlib/REPL/src/docview.jl und füge Einträge für die verbleibenden Sonderzeichen hinzu: `.` für Broadcasting, `\`` für Befehle und `;` für andere Verwendungen. Folge dem Muster der bereits implementierten Zeichen.
Tech Stack
Keine
Domain
developer experience
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitJulia
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75