Reference pages link to non-existent extension anchors

Open

#681 opened on Sep 27, 2021 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

OpenCL Extension Spec

Dominant language: Python
Stars: 421
Forks: 132
Avg merge: 5d 13h
Merged PRs (30d): 11

Description

Various links in man/static/clFOO.txt link to OpenCL_Ext.html#clFoo when there is no clFoo anchor in that document. This doesn't cause much of an issue, as the link exists, you just land at the top of the document.

The fix is either to link to the anchor of the extension that describes clFoo, or to add an anchor for clFoo.

This is the list of offending links I found (the links appear like this in the source verbatim, so you can find them by searching):

Contributor guide

Open the contributing guide

First steps

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

Research direction

Search the listed OpenCL_Ext.html URLs in the reference sources under man/static/clFOO.txt, then compare each target with the available anchors in OpenCL_Ext.html. Update each link to the extension anchor that describes the function or add an anchor where appropriate. Done means all listed links resolve to the intended location instead of the top of the document.

Written by the indexing model from the issue text.

Assessment

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