Closed lagru closed 7 months ago
Okay, finally Python 3.9 is happy (sorry for the notification noise). I think this is ready to merge.
As a real world example, this
changelist scikit-image/scikit-image 54316d5~1 54316d5
includes just the merge commit from https://github.com/scikit-image/scikit-image/pull/6695 and creates the following notes:
Let me know what you think. :)
@stefanv, could I ask you to have a look at this if you have the time? :pray: Not the highest priority in my opinion but I'd hate to rush this just before our next skimage release.
@lagru Let me know if you intend to make any other changes, otherwise I'll merge.
@stefanv. I've addressed all your comments and switched to the {label="Some label"}
based syntax. This {...}
block can be added anywhere once in the summary. So it can be used as a fenced_code_attributes that is hidden, or anywhere else so that it's visible.
I've also added basic tests for this in test_objects.py
.
As we talked about, I've added a section in the README to document the new feature and make it clearer how to use it. It's duplicating the documentation in the config a little bit, but it's probably less hidden this way and should read nicer (no talk of regex).
Thanks Lars!
Tackles the first case in https://github.com/scientific-python/changelist/issues/45:
It would be good to have this in before the next release of scikit-image. So that changelist can gracefully deal with https://github.com/scikit-image/scikit-image/pull/6695.