Macaulay2 / Macaulay2/M2

Popular symbols

Open
#1,649 41 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

This is a proposal to
1. find symbols that are frequently used by package authors (e.g., for method/option names)
2. define them in the `Core` (in case of methods we need to think about a default way of doing this)
3. standardize our approach to this

As two examples I have
- `Jacobian` defined in `ReesAlgebra`
- `truncate` defined in `Truncations`
In both cases I'm forced to "export" the corresponding packages just in order to use these symbols... or face the "shadow" warning (and be forced to use prefixes) --- these two packages load at startup.

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 examining the Core symbol definitions and the examples in ReesAlgebra and Truncations, especially Jacobian and truncate. Trace how package loading, exporting, shadow warnings, and prefixes currently interact. Done would require an agreed standard and an implemented approach for frequently used symbols, but the issue does not specify files or tests.

Written by the indexing model from the issue text.

Assessment

Domain
compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.