diff --git a/docs/release_notes.py b/docs/release_notes.py index 97956038..16baef98 100644 --- a/docs/release_notes.py +++ b/docs/release_notes.py @@ -22,7 +22,7 @@ def parse_pre_release_file(path): Uses empty list when no info was entered for the section. """ print(f'Checking {path} for release notes.') - with path.open('r') as fd: + with path.open('r', encoding='utf-8') as fd: lines = fd.readlines() section_dict = defaultdict(list) @@ -48,7 +48,7 @@ def extend_release_notes(path, version, release_notes): """ Given dict mapping of section to lines, extend the release notes file. """ - with path.open('r') as fd: + with path.open('r', encoding='utf-8') as fd: lines = fd.readlines() new_lines = ['\n', '\n'] @@ -71,7 +71,7 @@ def extend_release_notes(path, version, release_notes): print('Writing out release notes file') for line in new_lines: print(line.strip('\n')) - with path.open('w') as fd: + with path.open('w', encoding='utf-8') as fd: fd.writelines(output_lines) diff --git a/docs/source/release_notes.rst b/docs/source/release_notes.rst index 7471198b..d72d3816 100644 --- a/docs/source/release_notes.rst +++ b/docs/source/release_notes.rst @@ -1,6 +1,23 @@ Release History ############### +v3.1.0 (2023-12-05) +=================== + +Features +-------- +- Add overridable ``find_signal`` method to the ``SignalConnection`` class to allow + the use of alternate signal registries in subclasses. +- Updated look and feel: change the typhos suite cli defaults to + "embedded" displays arranged "vertically" instead of + "detailed" displays arranged "horizontally" + to more naturally match how typhos is used at present. + +Contributors +------------ +- canismarko +- zllentz + v3.0.0 (2023-09-27) =================== diff --git a/docs/source/upcoming_release_notes/595-maint_cli_defaults.rst b/docs/source/upcoming_release_notes/595-maint_cli_defaults.rst deleted file mode 100644 index ec6a46d3..00000000 --- a/docs/source/upcoming_release_notes/595-maint_cli_defaults.rst +++ /dev/null @@ -1,25 +0,0 @@ -595 maint_cli_defaults -###################### - -API Breaks ----------- -- Default typhos suites to "embedded" displays arranged "vertically" instead of - "detailed" displays arranged "horizontally" to more naturally match how typhos is - used at present. - -Features --------- -- N/A - - -Bugfixes --------- -- N/A - -Maintenance ------------ -- N/A - -Contributors ------------- -- zllentz