Make CHANGES.html more useful #38425
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Documentation preview for this PR (built with commit 5dfe4e3; changes) is ready! 🎉 |
|
Thanks. For more useful diffs and doc build speed up, we may consider turning off "preparsed examples" for docs of develop versions. What do you think? |
5 tasks
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jul 31, 2024
<!-- ^ 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 sagemath#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 sagemath#12345". --> Currently not so useful... Compare https://doc-pr-38414--sagemath.netlify.app/changes (before this PR) and https://doc-pr-58--sagemath-test.netlify.app/changes (after this PR) Improvements: 1. Each hunk in diffs is paired with a link to the location. 2. The algorithm searching location to plant anchors is now slightly improved. 3. More non-visual diffs (spurious) are removed. Some links of hunks in https://doc-pr-58--sagemath- test.netlify.app/changes may seem not working, but this is just because the anchor is planted inside an **inactive** tab of examples! ### 📝 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. - [ ] 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, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#38425 Reported by: Kwankyu Lee Reviewer(s): Matthias Köppe
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Aug 2, 2024
<!-- ^ 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 sagemath#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 sagemath#12345". --> Currently not so useful... Compare https://doc-pr-38414--sagemath.netlify.app/changes (before this PR) and https://doc-pr-58--sagemath-test.netlify.app/changes (after this PR) Improvements: 1. Each hunk in diffs is paired with a link to the location. 2. The algorithm searching location to plant anchors is now slightly improved. 3. More non-visual diffs (spurious) are removed. Some links of hunks in https://doc-pr-58--sagemath- test.netlify.app/changes may seem not working, but this is just because the anchor is planted inside an **inactive** tab of examples! ### 📝 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. - [ ] 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, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#38425 Reported by: Kwankyu Lee Reviewer(s): Matthias Köppe
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Aug 27, 2024
<!-- ^ 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 sagemath#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 sagemath#12345". --> Still after sagemath#38425, the script generating CHANGES.html needs improvement. (1) Fixes sagemath#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, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#38468 Reported by: Kwankyu Lee Reviewer(s): Matthias Köppe
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Aug 28, 2024
<!-- ^ 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 sagemath#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 sagemath#12345". --> Still after sagemath#38425, the script generating CHANGES.html needs improvement. (1) Fixes sagemath#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, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#38468 Reported by: Kwankyu Lee Reviewer(s): Matthias Köppe
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently not so useful...
Compare
https://doc-pr-38414--sagemath.netlify.app/changes (before this PR)
and
https://doc-pr-58--sagemath-test.netlify.app/changes (after this PR)
Improvements:
Each hunk in diffs is paired with a link to the location.
The algorithm searching location to plant anchors is now slightly improved.
More non-visual diffs (spurious) are removed.
Some links of hunks in https://doc-pr-58--sagemath-test.netlify.app/changes may seem not working, but this is just because the anchor is planted inside an inactive tab of examples!
📝 Checklist
⌛ Dependencies