JuliaDocs / JuliaDocs/DocStringExtensions.jl

Recompilation and load time

Open
#169 12 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
126
Forks
35
PR merge metrics
No merged PRs in 30d

Description

According to @time and @time_imports, DocStringExtensions seems to recompile on every load, resulting in comparatively long load time (seems to vary a lot, but I've seen up to 75 ms). Now that very low level packages like SpecialFunctions depend on DocStringExtensions, this is becoming more noticeable. Is this inherent (recompilation) to the way DocStringExtensions works, or can we do something about this?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the reported load-time behavior with Julia's @time and @time_imports around loading DocStringExtensions, comparing repeated loads. Trace the package's loading and recompilation behavior to determine whether the cost is inherent or avoidable. Done means the cause is established and a concrete, tested path to reduce or eliminate unnecessary recompilation is identified.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
performance
Issue type
Bug
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.