Incorrect links in documentation examples
Nobody has claimed this yet.
- Dominant language
- Macaulay2
- Stars
- 435
- Forks
- 297
- Avg merge
- 4d 20h
- Merged PRs (30d)
- 11
Description
Let me go straight to an example. Try the following (in emacs! though obviously you can remove the `topLevelMode` stuff and do it in the web app too)
```
i1 : topLevelMode=WebApp;s=last capture "ofClass class 3"; topLevelMode=Standard; s
o4 = i1 : ofClass ZZ
o1 = an integer
o1 :
SPAN
i2 :
```
Ignoring the weird symbols, the point is that the link is looking good.
Now the problem is, when documentation examples are generated and output to the corresponding `.out` file, the links are *not* correct.
For example, for the same example as part of the documentation of `ofClass`, I get instead
```
an integer
```
which means both `help ofClass` and `viewHelp ofClass` (in WebApp mode) have broken links.
This has been around for at least a month (I first noticed it on Dec 22). Before that, there was a placeholder prefix `${prefix}$` which allowed to fix the link after the fact.
I understand it mostly affects the web app doc, not so much the normal documentation (though there may be some cases where it affects both? not sure), but still, it would be nice to fix or at least revert to how it was before.
Contributor guide
No contributing guide indexed for this repository
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
Reproduce the `ofClass` example in Emacs and WebApp mode, then compare the generated `.out` link with the working link shown in the issue. Trace the documentation-example generation path; done means `help ofClass` and `viewHelp ofClass` produce links that resolve correctly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100