Macaulay2 / Macaulay2/M2

Doc page with unescaped hashtags - math mode vs. code

Open
#2,939 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

The doc page for higherHomotopies is currently broken because of unescaped hashtags. In particular, line 63 of the html code (view page source on the website, or 3715 in CompleteIntersectionResolutions.m2, read

```
... and $$ H#\{e0,i+1\}*H#\{e,i\}+H#\{e,i-1\}H#\{e0,i\} = f_i, $$ where $e0 = \{0,\dots,0\}$ and $e$...
```

but should be

```
... and $$ H\#\{e0,i+1\}*H\#\{e,i\}+H\#\{e,i-1\}H#\{e0,i\} = f_i, $$ where $e0 = \{0,\dots,0\}$ and $e$...
```

There are a number of other issues with the appearance of this documentation page. This is likely a more general problem affecting many pages.

More generally though, why are these being rendered as tex instead of as macaulay2 code, like in the following?

```

i1 : kk=ZZ/101

o1 = kk

o1 : QuotientRing


```

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 with line 3715 in CompleteIntersectionResolutions.m2 and compare it with line 63 of the generated HTML/source for the higherHomotopies page. Inspect how hashtags and Macaulay2 code blocks are rendered, then check whether the same issue appears on other documentation pages. Done means the affected page displays the intended math and code formatting, with the broader rendering behavior understood or corrected.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.