Move OptionalComponentsPresent from newPackage to beginDocumentation
- Dominant language
- Macaulay2
- Stars
- 435
- Forks
- 297
- Avg merge
- 4d 20h
- Merged PRs (30d)
- 11
Description
I generally don't appreciate packages that run an external program upon being loaded (which also ends up happening when `Macaulay2Doc` is being installed, c.f. #3292).
Perhaps `OptionalComponentsPresent` should be set _after_ `newPackage` in the call to `beginDocumentation`, so that loading could stop there if the optional component is not present.
(Originally from https://github.com/Macaulay2/M2/pull/3366#discussion_r1685557557)
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by tracing the OptionalComponentsPresent handling in newPackage and beginDocumentation, and review the context from pull request #3366 and issue #3292. Determine when loading Macaulay2Doc invokes an external program and define the intended behavior when the optional component is absent; done means package loading no longer triggers that work prematurely.
Written by the indexing model from the issue text.
Assessment
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100