Macaulay2 / Macaulay2/M2

bug in simple doc or during creation of a method

Open
#2,867 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

The following code (note the return type is `ideal`, not `Ideal`!) gives an error during `installPackage`. Removing the doc node, or changing the return type to `Ideal` both work correctly. Perhaps when creating a method, we should make sure the suggested return type is a type?

```
-- DocBug.m2
newPackage(
"DocBug",
Version => "0.1",
Date => "8 June 2023",
Headline => "bug in Core",
AuxiliaryFiles => false,
DebuggingMode => true
)

export {"myfun"}

myfun = method()
myfun(ZZ) := ideal => n -> (
ideal 0_ZZ
)

beginDocumentation()

doc ///
Key
(myfun, ZZ)
Headline
compute
Usage
myfun n
///

end--

-* Development section *-
restart
debug needsPackage "DocBug"
check "DocBug"

uninstallPackage "DocBug"
restart
installPackage "DocBug"
viewHelp "DocBug"
```

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

Reproduce the failure using the DocBug.m2 example, focusing on installPackage and the documented myfun method with return type ideal. Trace how method creation and the doc node process the suggested return type; done means the package installs successfully and viewHelp works without changing ideal to Ideal or removing the documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.