Add deprecation note for ServerApp.preferred_dir (#1396)

krassowski · pre-commit-ci[bot] · web-flow · commit 7d3264d02f97 · 2024-02-15T13:49:45.000-06:00
Co-authored-by: pre-commit-ci[bot] &lt;66853113+pre-commit-ci[bot]@users.noreply.github.com&gt;
diff --git a/jupyter_server/serverapp.py b/jupyter_server/serverapp.py
@@ -1740,7 +1740,9 @@ def _root_dir_changed(self, change: t.Any) -> None:
 
     preferred_dir = Unicode(
         config=True,
-        help=trans.gettext("Preferred starting directory to use for notebooks and kernels."),
+        help=trans.gettext(
+            "Preferred starting directory to use for notebooks and kernels. ServerApp.preferred_dir is deprecated in jupyter-server 2.0. Use FileContentsManager.preferred_dir instead"
+        ),
     )
 
     @default("preferred_dir")

Original file line number	Diff line number	Diff line change
`@@ -1740,7 +1740,9 @@ def _root_dir_changed(self, change: t.Any) -> None:`
`1740`	`1740`
`1741`	`1741`	`preferred_dir = Unicode(`
`1742`	`1742`	`config=True,`
`1743`		`- help=trans.gettext("Preferred starting directory to use for notebooks and kernels."),`
	`1743`	`+ help=trans.gettext(`
	`1744`	`+ "Preferred starting directory to use for notebooks and kernels. ServerApp.preferred_dir is deprecated in jupyter-server 2.0. Use FileContentsManager.preferred_dir instead"`
	`1745`	`+ ),`
`1744`	`1746`	`)`
`1745`	`1747`
`1746`	`1748`	`@default("preferred_dir")`