DoubleML / DoubleML/doubleml-for-r

Hyperlinks in R API reference are broken

Open
#59 1 comment 0 reactions 0 assignees View on GitHub
documentation question
Dominant language
R
Stars
169
Forks
34
Avg merge
1d 19h
Merged PRs (30d)
3

Description

If one selects a subclass (like `DoubleMLPLR`) and expands the inherited methods (from `DoubleML`) the hyperlinks don't work.

See screenshots
![image](https://user-images.githubusercontent.com/7427117/106932654-49cd4f00-6718-11eb-91a7-fc06e61d67f6.png)
![image](https://user-images.githubusercontent.com/7427117/106932974-ae88a980-6718-11eb-9c42-f8310ff12be8.png)

It links to https://docs.doubleml.org/r/DoubleML/html/DoubleML.html#method-confint. It is reachable under https://docs.doubleml.org/r/stable/reference/DoubleML.html#method-confint.
--> Could be related to the "stable" subfolder but maybe it's also a specification in pkgdown which is not yet set appropriately.

Contributor guide

Open the contributing guide

Research direction

Reproduce the broken inherited-method links from the R API reference using a subclass such as DoubleMLPLR, then compare the generated URL with the working stable/reference/DoubleML.html#method-confint path. Start by inspecting the pkgdown configuration and reference-generation settings related to the stable subfolder. Done means inherited-method hyperlinks resolve to the corresponding stable reference pages.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.