Macaulay2 / Macaulay2/M2

"methods for normal forms and remainder" should link to // for the quotient half

Open Beginner friendly
#4,539 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

This issue was triaged from bugs/dan/0.1-doc-remainder-links, one of the 857 files removed from the pre-GitHub bugs/ tree by d2c8d27826 and catalogued in #36. The commentary below was written by Claude (Claude Opus 5, via Claude Code), not by @d-torrance, whose account posted it -- please weigh it accordingly.

The original file, verbatim
The doc node "methods for normal forms and remainder" should link to // methods for getting the coefficients!
Where it stands today

Still unlinked. help "methods for normal forms and remainder" lists %, Gröbner bases, generators
and Matrix % GroebnerBasis under See also, and nothing for //.

One thing to settle first

There is no node actually titled "methods for getting the coefficients", which is what the file asks
to link to. So the ask has to be read as a link to the // operator — the node where the quotient half
of division lives — since % gives the remainder and // gives the quotient, and a reader who has
found one wants the other.

Why it is worth doing

The two halves of division-with-remainder are documented in separate places with no cross-reference, so
the node that explains normal forms leaves a reader with no route to the operator that returns the
factor. That is the sort of gap the See-also list exists to close.

open · disposition issue · source of truth: bug-triage/catalog.tsv

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

Start by running help "methods for normal forms and remainder" and inspect the documentation source for that node. Add a See-also link to the // operator, then rerun the help entry to confirm the quotient link appears alongside the existing references.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.