Skip to content

Conversation

@Steph-Chong
Copy link
Collaborator

I have started updating the release notes, to track upcoming release Version 1.1.0

@nicholasloveday could you please review what I have written about adding the 5 new threshold weighted scores (in "Features" section)?

  1. If there are any changes you want made, please let me know.
  2. Also, if you want the order changed, please also let me know (I went with the order they were listed at one point in the tutorial).

@tennlee @nicholasloveday - could one (or both of you) please review what I have written about modifying trapezoidal call to work with either NumPy 1 or 2.

  1. Is "Internal Changes" the correct section, or should it be in one of other sections?
  2. Is the wording I have used clear enough, or should it be modified?
  3. Should I specify where the change was made (it looks like it was made in ROC)?

Note: just before the Version 1.1.0 is released, three last minute changes will need to be made. (1) "Upcoming Release" will need to be changed to the date, (2) in the GitHub commit history URL, "develop" will need to be changed to "1.1.0" and (3) any unused section headers will need to be deleted.

@Steph-Chong
Copy link
Collaborator Author

I left out some changes that didn't seem significant enough to call out in the release notes (e.g. changing the thumbnail image for Data Fetching in the tutorial gallery, fixing some rendering issues in some API docstrings, minor tweak to maintainer's notes). All of these changes are visible if you follow the GitHub commit history link. However, if it would be better for some/all of those changes to be mentioned in the release note, just let me know and I can add them.

@nicholasloveday
Copy link
Collaborator

The notes about the threshold weighted scores look good to me. Thanks.

The trapezoidal note is clear to me. I'm happy to go with that or whatever @tennlee suggests.

@Steph-Chong
Copy link
Collaborator Author

Steph-Chong commented Aug 2, 2024

I took the opportunity to enter some basic information for each (non-yanked and non-identical) release from 0.0.1 to 0.9.2 inclusive. At the moment, they mostly list the version number, the release date and a link to the GitHub commit history. They don't include a summary of the most noteworthy changes.

Ideally, I would like to add a summary of the noteworthy changes to each version entry. But if I do that, I will most likely do it in batches over time. (I am reluctant to cut and paste the existing release notes from the GitHub entries, as they are inconsistent in what they do and don't include, and some releases don't have any summary notes).

Signed-off-by: Stephanie Chong <168800785+Steph-Chong@users.noreply.github.com>
@Steph-Chong
Copy link
Collaborator Author

Changed "trapezoidal" to "numpy.trapezoid" following offline feedback from Tennessee

Signed-off-by: Stephanie Chong <168800785+Steph-Chong@users.noreply.github.com>
@tennlee tennlee merged commit c946d7d into nci:develop Aug 2, 2024
@Steph-Chong Steph-Chong deleted the Update-Release-Notes branch August 2, 2024 07:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants