Skip to content

DOC: remove the concept of pre-release notes#1416

Merged
ZLLentz merged 3 commits intopcdshub:masterfrom
ZLLentz:doc_simplify_relnotes
May 1, 2026
Merged

DOC: remove the concept of pre-release notes#1416
ZLLentz merged 3 commits intopcdshub:masterfrom
ZLLentz:doc_simplify_relnotes

Conversation

@ZLLentz
Copy link
Copy Markdown
Member

@ZLLentz ZLLentz commented Apr 30, 2026

Description

Remove the pre-release notes system that I had created some years back

Motivation and Context

  • The system is easy to forget to do and adds extra review overhead
  • The text is redundant with what github can generate automatically and with what we store in the github releases section
  • People usually do it wrong anyway- everyone does it wrong sometimes, even me

How Has This Been Tested?

I'll download and double-check the generated sphinx docs

Where Has This Been Documented?

I updated the pre-merge checklist

Pre-merge checklist

  • Code works interactively
  • Code contains descriptive docstrings, including context and API
  • New/changed functions and methods are covered in the test suite where possible
  • Test suite passes locally
  • Test suite passes on GitHub Actions

@ZLLentz ZLLentz requested review from a team as code owners April 30, 2026 23:57
janeliu-slac
janeliu-slac previously approved these changes May 1, 2026
@ZLLentz
Copy link
Copy Markdown
Member Author

ZLLentz commented May 1, 2026

After merging in Truman's changes from #1415 I will need to make one more edit here

@ZLLentz ZLLentz merged commit cc3954d into pcdshub:master May 1, 2026
7 checks passed
@ZLLentz ZLLentz deleted the doc_simplify_relnotes branch May 1, 2026 23:07
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.

2 participants