QuantumBFS/Yao.jl

Some source links in the doc are incorrect

Open

#234 opened on Feb 28, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Julia (1,029 stars) (130 forks)batch import
help wanted

Description

For example:

http://docs.yaoquantum.org/stable/man/registers.html#YaoBase.nactive

image

It will jump to https://github.com/JuliaLang/julia/blob/46ce4d79337bdd257ee2e3d2f4bb1c55ff0a5030/base/#L0-L8 .

I guess it relates to the code here:

https://github.com/QuantumBFS/YaoBase.jl/blob/master/src/utils/interface.jl#L30

Any idea how to fix it?

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
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.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Knowledge of JuliaFamiliarity with documentation system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Investigate the source link generation code in src/utils/interface.jl (line 30) and related documentation generation scripts. Determine why links point to incorrect Julia base repository instead of the correct file. Fix the mapping or URL construction to ensure all documentation source links are accurate.