Skip to content

Commit

Permalink
gh-38468: Fix buggy doc diff script
Browse files Browse the repository at this point in the history
    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes #12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes #12345". -->

Still after #38425, the script generating CHANGES.html needs
improvement.

(1) Fixes #38467

test: https://github.com/kwankyu/sage/actions/runs/10257146932/job/28377
629063?pr=63
test:  https://doc-pr-63--sagemath-test.netlify.app/changes

(2) As seen in https://doc-pr-38339--sagemath.netlify.app/changes (hunk
1), the anchor may be planted in a line very far from where the diff is.

test: https://doc-pr-65--sagemath-test.netlify.app/changes  (hunk 1)

(3) As seen in https://github.com/sagemath/sage/actions/runs/10235554395
/job/28316513988?pr=38449, the script may fail (and hence doc build
github workflow as well) by a bug (I failed to consider that git diff
counts lines from 1).

test: https://github.com/kwankyu/sage/actions/runs/10257125674/job/28377
566493?pr=64
test: https://doc-pr-64--sagemath-test.netlify.app/changes (warning:
slow loading)

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [x] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - #12345: short description why this is a dependency -->
<!-- - #34567: ... -->
    
URL: #38468
Reported by: Kwankyu Lee
Reviewer(s): Matthias Köppe
  • Loading branch information
Release Manager committed Aug 27, 2024
2 parents d7837bc + ed749a4 commit 60957ac
Showing 0 changed files with 0 additions and 0 deletions.

0 comments on commit 60957ac

Please sign in to comment.