JuliaPluto/Pluto.jl

Live Docs: show package defining a function

Open

#2.737 aberto em 6 de dez. de 2023

Ver no GitHub
 (6 comments) (1 reaction) (0 assignees)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:

Guia do colaborador

Pilha de tecnologia
None
Domain
documentationfrontend
Tipo Issue
feature
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
Understanding of Pluto's live docs structureBasic HTML/CSS knowledge
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70
Direção de pesquisa
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.