Macaulay2 / Macaulay2/M2

Documentation links to types that conflict with a package name

Open
#3,543 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Core Documentation
Dominant language
Macaulay2
Stars
435
Forks
297
Avg merge
4d 20h
Merged PRs (30d)
11

Description

Here's a sentence from the documentation of [SpaceCurves](https://macaulay2.com/doc/Macaulay2/share/doc/Macaulay2/SpaceCurves/html/index.html):
> The method [smoothDivisors](https://macaulay2.com/doc/Macaulay2/share/doc/Macaulay2/SpaceCurves/html/_smooth__Divisors.html) produces a list of [Divisor](https://macaulay2.com/doc/Macaulay2/share/doc/Macaulay2/Divisor/html/index.html) of a given degree on a given surface.

The first link is to a method in the package SpaceCurves, but the second link is to the _package Divisor_ rather than the _type [Divisor](https://macaulay2.com/doc/Macaulay2/share/doc/Macaulay2/SpaceCurves/html/___Divisor.html)_ introduced in SpaceCurves.

This is even an issue in the documentation for methods that use a Divisor, e.g. [curve](https://macaulay2.com/doc/Macaulay2/share/doc/Macaulay2/SpaceCurves/html/_curve.html):
> Inputs:
> - D, an instance of the type [Divisor](https://macaulay2.com/doc/Macaulay2/share/doc/Macaulay2/Divisor/html/index.html)

We try to make sure `TO` links prioritize the current package before exploring matching nodes in other packages, possibly by prepending `currentPackage` here:
https://github.com/Macaulay2/M2/blob/1fd238210e9a37ddaec3b700ccd22f06ff5f28f5/M2/Macaulay2/m2/document.m2#L384-L387

Contributor guide

No contributing guide indexed for this repository

First steps

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

Research direction

Start in M2/Macaulay2/m2/document.m2 around lines 384-387 and read how TO links resolve matching nodes across packages. Compare the SpaceCurves documentation links for smoothDivisors, curve, and Divisor with the linked Divisor package pages. Done means references to SpaceCurves' Divisor type resolve to the SpaceCurves documentation while unrelated references still resolve correctly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
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.