Documentation refresh - Atlanta workshop#4341
Closed
aalmousa wants to merge 90 commits into
Closed
Conversation
Remove some todos and dead methods
Add a new tutorial file M2/Macaulay2/packages/Macaulay2Doc/tu_NAG.m2 covering homotopy continuation, witness sets, and examples using the NumericalAlgebraicGeometry package. Register the tutorial in loads.m2 and add it to the top-level navigation in ov_top.m2.
Various documentation improvements and minor metadata fixes across packages. - Macaulay2Doc/tu_NAG.m2: add inline comment clarifying parameter point and expected solution count. - MonodromySolver.m2: update contact emails for Timothy Duff and Kisun Lee. - MonodromySolver/Documentation.m2: expand and reorganize docs (specializeSystem, createSeedPair example, timing/getTrackTime notes), consolidate and enrich PointArray documentation, remove several small obsolete doc stubs. - NumericalAlgebraicGeometry/doc.m2: add comprehensive docs for evaluateH/evaluateHx/evaluateHt with usage and examples; add and extend specialize/specialize(PH,...) docs and SpecializedParameterHomotopy descriptions and examples; clean up redundant fragments. - SLPexpressions: remove functions from undocumented list and add full documentation for support, printAsSLP, and cCode in SLPexpressions/doc.m2 (headlines, usage, examples). These changes primarily improve user-facing documentation and examples to make homotopy/parameter handling and SLP utilities clearer.
Updated NAG tutorial (based on Taylor's suggestions).
kernel docs updates
Missed variable name change in tensor doc examples
… fixed Adjust documentation across Macaulay2 packages: - GenericInitialIdeal: extend the document Key for gin to include (gin,Ideal) and (gin,QuotientRing); comment out the separate document nodes for those keys to avoid duplication. - map-doc: tidy the Galois field map documentation—reorder explanations, move the three-argument form description, update the example to handle non-existing maps with a try/else, and add TO (map,GaloisField,GaloisField) to the list of documented signatures. - tu_NAG: add "NumericalSchubertCalculus" to the NAG package list. These are documentation-only changes to improve clarity and register additional interfaces.
Add a detailed introduction and explicit section outline to M2/Macaulay2/packages/Tutorials/tu_NAG.m2. The tutorial now includes an overview and lists sections A–E (Homotopy continuation; Witness sets and numerical irreducible decomposition; Monodromy method; Numerical certification; Numerical implicitization), plus minor formatting adjustments before the existing quick-start text.
Enrich the Macaulay2 debugging docs (ov_debugging.m2) with a detailed, step-by-step example session: load a demo file, show available symbols (listUserSymbols), display function source (code), trigger the debugger and inspect locals (listLocalSymbols), and demonstrate debugger commands (step, break, end) and the errorDepth setting. Also documents non-interactive error handling using try and trap and includes illustrative REPL output to make debugging workflows clearer for users.
Replace Kisun Lee's contact email in NumericalCertification.m2 package metadata from kil004@ucsd.edu to kisunl@clemson.edu to reflect the author's updated contact information.
Add TO entries for the debugging commands 'continue' and 'trap' in M2/Macaulay2/packages/Macaulay2Doc/ov_debugging.m2 so they appear in the module's exported TO list.
Add a trailing space after "deeper." in M2/Macaulay2/packages/Macaulay2Doc/ov_debugging.m2 to ensure correct spacing when the documentation strings are concatenated/printed. This is a minor whitespace-only formatting fix to improve output readability.
Member
Author
|
A rebased replacement for this shared-branch draft is now open as #4345. I left |
Member
|
I appreciate this! :) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is a draft PR from the documentation refresh work that was done at the Atlanta "Building the Future of Macaulay2" workshop.