Macaulay2 / Macaulay2/M2

Incorrect location for undocumented Core methods

Open
#3,310 2 comments 0 reactions 0 assignees View on GitHub
Core
Dominant language
Macaulay2
Stars
435
Forks
297
Avg merge
4d 20h
Merged PRs (30d)
11

Description

For example:

```m2
i1 : locate makeDocumentTag (sin, Number)

o1 = /usr/share/Macaulay2/typicalvalues.m2:271:0

o1 : FilePosition
```
That file doesn't exist! It should be `/usr/share/Macaulay2/Core/typicalvalues.m2`.

I think the problem is that we call `undocumented` on this method in `Core`, but `makeDocumentTag` changes the package to `Macaulay2Doc`, messing up the path.

Contributor guide

No contributing guide indexed for this repository

Research direction

Reproduce the `locate makeDocumentTag (sin, Number)` example and inspect the `undocumented` handling in `Core`, along with `makeDocumentTag` and `Macaulay2Doc`. Trace how the package changes while generating the location for `Core/typicalvalues.m2`; done means the reported path points to the existing Core file.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.