Repository navigation
Conversation
cd2e9ca to
c7d3412
Compare
ABACUS-PR-BOT
left a comment
There was a problem hiding this comment.
Static review of the complete diff at c7d34121745b, independently checked against the configured Markdown/MyST rules. The comments cover four documentation/configuration regressions and one non-blocking link suggestion; no documentation build, formatter hook, or ABACUS runtime was executed.
| - id: mdformat | ||
| args: [--wrap, "100"] | ||
| additional_dependencies: | ||
| - mdformat-gfm |
There was a problem hiding this comment.
The formatting changes TeX itself: for example, \sum becomes \\sum and subscripts gain escapes in hs_matrix.md, pp_orb.md, and hsolver.md. With dollarmath enabled in docs/conf.py, MyST passes these payloads directly to math nodes, so these are changed operators/subscripts rather than harmless prose escapes. Please restore the original math and use formatting support for this MyST syntax (or exclude unsupported files), checking math-token preservation before reformatting.
| --- | ||
| ______________________________________________________________________ | ||
|
|
||
| ## applyTo: "\*\*" |
There was a problem hiding this comment.
This changes the YAML applyTo: "**" frontmatter into a thematic break and a heading. Copilot reads that glob from frontmatter to select path-specific instructions, so the heading no longer supplies the all-files selector. Please restore the frontmatter and preserve it during formatting, or exclude this instruction file from unsupported formatting.
| | number of atoms | 'TOTAL ATOM NUMBER\\s\*=\\s\*(\\d+)' | `TOTAL ATOM NUMBER = 2` | | ||
| | lattice constant | 'lattice constant (Angstrom)\\s\*=\\s\*(-?\\d+(.\\d+)?)' | `lattice constant (Angstrom) = 0.529177` | | ||
| | lattice vectors | '^Lattice vectors: (Cartesian coordinate: in unit of a_0)$' | ` Lattice vectors: (Cartesian coordinate: in unit of a_0)` | | ||
| | coordinate system | '^(DIRECT | CARTESIAN) COORDINATES' | |
There was a problem hiding this comment.
The escaped alternation pipe has become a table separator: this row now contains the regex fragment '^(DIRECT and puts CARTESIAN) COORDINATES' in the example column, losing the original DIRECT COORDINATES example. The k-point and eigenvalue rows also lose cell contents. Please restore the complete original cells and preserve literal \| inside regex cells when formatting.
| @@ -1,10 +1,13 @@ | |||
| # Migration Guide: New CSR Format for H\(R\) and S\(R\) Matrices | |||
| # Migration Guide: New CSR Format for H(R) and S(R) Matrices | |||
There was a problem hiding this comment.
Removing the escapes from H\(R\) and S\(R\) changes their meaning under the existing MyST replacements extension: the title and overview now parse as H® and S®. Please preserve the protected parentheses or put these matrix symbols in math/code spans, and check with the enabled replacements rule.
|
|
||
| - Integration test and unit tests (`test.yml`): This action builds ABACUS with all available | ||
| features, runs integration tests, and runs unit tests. It also performs | ||
| [static analysis](../CONTRIBUTING.md#code-formatting-style) with \<pre-commit.ci>. |
There was a problem hiding this comment.
Non-blocking: escaping the opening < removes the pre-commit.ci hyperlink under the enabled MyST linkify rule. Could this use an explicit HTTPS link instead, so the service remains directly reachable from this page? A follow-up after merge is fine.
Two notes:
mdformatuses1. / 1. / 1.instead of1. / 2. / 3.. I think this is a sensible default and am reluctant to change it. It avoids unnecessary numbering changes in diffs when list items are added, removed, or reordered. The rendered lists are still numbered consecutively as1 / 2 / 3.