search

slaclab / pydm

Python Display Manager
http://slaclab.github.io/pydm/
Other
112 stars 77 forks source link

Lack of Documentation on version v1.11.1 #739

Closed ZLLentz closed 2 years ago

ZLLentz commented 3 years ago

Version v1.11.1 has a very short release notes blurb about the two most recent changes to the library, but actually incorporates a number of other pull requests, some of which added features, and at least one of which (rules enum change) is not backwards compatible- this behavior change required an update to the pmps-ui application used on the photon side of lcls. I think it's worth going back to revise these release notes to be more complete.

Diff comparison for reference: https://github.com/slaclab/pydm/compare/v1.11.0...v1.11.1

hhslepicka commented 3 years ago

Oooops... my bad on the rules enum.

klauer commented 2 years ago

I don't think this was actually addressed. Perhaps you could just use GitHub's built-in support to regenerate the release notes for v1.11.1?

Giving it a try on https://github.com/slaclab/pydm/releases/tag/v1.11.1

PyDM 1.11.1 Release Notes

Nothing huge, just two small changes we wanted to get out sooner rather than later.

What's Changed

Full Changelog: https://github.com/slaclab/pydm/compare/v1.11.0...v1.11.1

YektaY commented 2 years ago

Ok, I have went ahead a updated the release notes in the same fashion. Thanks for the suggestion!