JuliaPluto/Pluto.jl

Live Docs: show package defining a function

Open

Aperta il 6 dic 2023

Vedi su GitHub
 (6 commenti) (1 reazione) (0 assegnatari)Julia (5295 star) (329 fork)batch import
Live Docsbackendenhancementfrontendgood first issue

Descrizione

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

Current:

Guida contributor

Tech stack
Nessuno
Dominio
documentationfrontend
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 hours
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Understanding of Pluto's live docs structureBasic HTML/CSS knowledge
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70
Direzione di ricerca
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.