Skip to content

Commit

Permalink
Flip default value for Windows' quicklaunch and deprecate it (#272)
Browse files Browse the repository at this point in the history
* Flip default value for Windows' `quicklaunch`

* deprecate quicklaunch

* add news
  • Loading branch information
jaimergp authored Nov 7, 2024
1 parent 549e2b5 commit a617792
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 4 deletions.
4 changes: 2 additions & 2 deletions menuinst/_schema.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,8 @@ class Windows(BasePlatformSpecific):

desktop: Optional[bool] = True
"Whether to create a desktop icon in addition to the Start Menu item."
quicklaunch: Optional[bool] = True
"Whether to create a quick launch icon in addition to the Start Menu item."
quicklaunch: Optional[bool] = False
"DEPRECATED. Whether to create a quick launch icon in addition to the Start Menu item."
terminal_profile: constr(min_length=1) = None
"""
Name of the Windows Terminal profile to create.
Expand Down
2 changes: 1 addition & 1 deletion menuinst/data/menuinst.default.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
},
"win": {
"desktop": true,
"quicklaunch": true,
"quicklaunch": false,
"terminal_profile": null,
"url_protocols": null,
"file_extensions": null,
Expand Down
2 changes: 1 addition & 1 deletion menuinst/data/menuinst.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -610,7 +610,7 @@
},
"quicklaunch": {
"title": "Quicklaunch",
"default": true,
"default": false,
"type": "boolean"
},
"terminal_profile": {
Expand Down
1 change: 1 addition & 0 deletions menuinst/platforms/win.py
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@ def _paths(self) -> Tuple[Path, ...]:
if self.metadata["desktop"]:
extra_dirs.append(self.menu.desktop_location)
if self.metadata["quicklaunch"] and self.menu.quick_launch_location:
warnings.warn("Quick launch menus are deprecated.")
extra_dirs.append(self.menu.quick_launch_location)

if extra_dirs:
Expand Down
19 changes: 19 additions & 0 deletions news/272-quicklaunch
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
### Enhancements

* <news item>

### Bug fixes

* <news item>

### Deprecations

* In v2-style schemas, Windows setting `quicklaunch` default value is now `false` and using it is considered deprecated. (#244 via #272)

### Docs

* <news item>

### Other

* <news item>

0 comments on commit a617792

Please sign in to comment.