Documentation links to types that conflict with a package name

[mahrud]

Here's a sentence from the documentation of SpaceCurves:

The method smoothDivisors produces a list of Divisor 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 introduced in SpaceCurves.

This is even an issue in the documentation for methods that use a Divisor, e.g. curve:

Inputs:

• D, an instance of the type Divisor

We try to make sure TO links prioritize the current package before exploring matching nodes in other packages, possibly by prepending currentPackage here:

M2/M2/Macaulay2/m2/document.m2

Lines 384 to 387 in 1fd2382

	-- TODO: if Package$Core was the same as Macaulay2Doc, this would not be necessary
	fetchAnyRawDocumentation String := fkey -> scan(prepend("Macaulay2Doc", loadedPackages), pkg -> (
	rawdoc := fetchRawDocumentation getPrimaryTag makeDocumentTag(fkey, Package => pkg);
	if rawdoc =!= null then break rawdoc))

[mahrud]

I think the situation is more complicated when both SpaceCurves and Divisor packages are loaded, since we need to make sure there's some way to access help for both the type and the package.

Perhaps a simpler fix is to rename the package to Divisors and encourage package titles to use plural names for this reason?