JuliaDocs/Documenter.jl

# hide not working anymore

Open

#1,690 opened on Sep 1, 2021

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Julia (513 forks)batch import
Type: Enhancementhelp wanted

Repository metrics

Stars
 (910 stars)
PR merge metrics
 (Avg merge 16d 9h) (3 merged PRs in 30d)

Description

I've updated Documenter.jl to v.0.27.5 and for some reason the "# hide" command does not seem to work anymore. I use it to hide plot generation, maybe there's a preferred way of doing that now? I don't see it mentioned anywhere. Here's an example where it fails:

using Plots
p=plot(1:3)
savefig("blah.svg"); nothing # hide

The last line is displayed in the html result and no svg is produced.

Contributor guide

Research direction
Compare the behavior of '# hide' between Documenter.jl v0.27.5 and previous versions. Look at the code path that handles hiding in example blocks, likely in the Markdown processing or output generation.
Tech stack
None
Domain
documentation
Issue type
Bug
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.
Mostly clear
Prerequisites
JuliaDocumenter.jl
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60