search

Macaulay2 / M2

The primary source code repository for Macaulay2, a system for computing in commutative algebra, algebraic geometry and related fields.
https://macaulay2.com
343 stars 230 forks source link

html documentation includes links to methods of packages #422

Closed DanGrayson closed 3 years ago

DanGrayson commented 8 years ago

For example, try viewHelp depth, and you'll see broken links to methods defined in the package Depth. Those methods are not listed by help depth.

jkyang92 commented 8 years ago

Additionally, it would be nice if the documentation for the versions of depth defined by Depth appeared with the Depth package documentation.

DanGrayson commented 8 years ago

That's up to the author of Depth, since it is not handled automatically for him. @bartsnapp ?

bartsnapp commented 8 years ago

I originally wrote depth, but have now "turned-it-loose." At the moment, I don't have time to make modifications. Anyone who is interested can work on it.

DanGrayson commented 8 years ago

Thanks, Bart.

DanGrayson commented 8 years ago

One documentation node in the package Depth serves to document each of the following methods:

      (depth, Ideal, Ring),
      (depth, Ring),
      (depth, Ideal, Module),
      (depth, Module),
      (depth, Ideal, Ideal),
      (depth, Ideal, PolynomialRing),
      (depth, Ideal, QuotientRing)

but it doesn't mention that the second argument could be a module. That's a separate issue from the issue I've reported here, so I've reported it here: #438 . Volunteers are welcome.

DanGrayson commented 8 years ago

The documentation node for "packages provided with Macaulay2" loads every package and then effectively dismisses it. The only reason it does that is to get the values of the parameters "Headline" and "Certification" to "newPackage". The problem is that package dismissal is incomplete: methods added to global method functions, such as "depth", remain, and then (broken) links to the documentation for those methods are made. That's related to the problem that we don't record the source package when installing such global methods, nor do we record a list of all global methods functions installed by a package when it is loaded.

mahrud commented 3 years ago

This is fixed now, although it is somewhat opposite of what #192 asked. I'll close this now, but if a change is needed, the discussion can continue there.

DanGrayson commented 3 years ago

Here's how it looks now:

Screen Shot 2020-12-02 at 1 08 05 PM
mahrud commented 3 years ago

I don't think you fully uploaded the screenshot.

DanGrayson commented 3 years ago

Oh, I see -- I have to wait!

mahrud commented 3 years ago

Is this not the intended output? I think if you want (depth, Module) to show up you need to add Depth to preloaded packages.

DanGrayson commented 3 years ago

No, it's okay now: no broken links.