JuliaPluto/Pluto.jl

Live Docs: show package defining a function

Open

#2 737 ouverte le 6 déc. 2023

Voir sur GitHub
 (6 commentaires) (1 réaction) (0 assignés)Julia (5 295 stars) (329 forks)batch import
Live Docsbackendenhancementfrontendgood first issue

Description

When reading docs, it would be nice to show from which package a function/method originates.

Current:

Guide contributeur

Stack technique
Aucun
Domaine
documentationfrontend
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Understanding of Pluto's live docs structureBasic HTML/CSS knowledge
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70
Direction de recherche
Review the Pluto.jl source code to understand how live docs are rendered. Search for the function display code (likely in a Julia file or a .js file). Look at the issue comments for any hints on desired implementation. Modify the relevant template or component to include the package name. Test the changes locally.