TopDirectory in Bertini
Nobody has claimed this yet.
- Dominant language
- Macaulay2
- Stars
- 435
- Forks
- 297
- Avg merge
- 4d 20h
- Merged PRs (30d)
- 11
Description
The way the package is set up, it fixes some global variables upon load:
https://github.com/Macaulay2/M2/blob/2565455411d15a3386204aa62a00e20ee5c0e99f/M2/Macaulay2/packages/Bertini.m2#L202-L214
Then, for instance, `storeBM2Files` gets used as default value of options:
https://github.com/Macaulay2/M2/blob/2565455411d15a3386204aa62a00e20ee5c0e99f/M2/Macaulay2/packages/Bertini.m2#L433-L436
Which results in the [documentation](https://macaulay2.com/doc/Macaulay2/share/doc/Macaulay2/Bertini/html/_bertini__User__Homotopy.html) changing every time:
> [TopDirectory](https://macaulay2.com/doc/Macaulay2/share/doc/Macaulay2/Bertini/html/___Top__Directory.html) => ..., default value "/tmp/M2-2629113-0/0", Option to change directory for file storage.
It's not the worst thing, but also not ideal I would think.
cc: @antonleykin
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with M2/Macaulay2/packages/Bertini.m2 at lines 202–214 and 433–436, then inspect the generated Bertini documentation for TopDirectory and Bertini User Homotopy. Trace how the load-time globals become option defaults; done means the generated documentation no longer includes a run-specific /tmp path.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100