Merge pull request #743 from stan-dev/release-notes-122

Update docs for release
stan-dev · Mar 26, 2024 · e096b6d · e096b6d
2 parents de2e73c + 50e9b1c
commit e096b6d
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 6 deletions.
diff --git a/docsrc/_static/images/logo_icon.png b/docsrc/_static/images/logo_icon.png
diff --git a/docsrc/_static/images/logo_tm.png b/docsrc/_static/images/logo_tm.png
diff --git a/docsrc/api.rst b/docsrc/api.rst
@@ -84,16 +84,16 @@ CmdStanGQ
 Functions
 *********
 
-compile_stan_model
-=============
+compile_stan_file
+=================
 
-.. autofunction:: cmdstanpy.compile_stan_model
+.. autofunction:: cmdstanpy.compile_stan_file
 
 
-format_stan_model
-=============
+format_stan_file
+================
 
-.. autofunction:: cmdstanpy.format_stan_model
+.. autofunction:: cmdstanpy.format_stan_file
 
 show_versions
 =============

diff --git a/docsrc/changes.rst b/docsrc/changes.rst
@@ -7,6 +7,19 @@ What's New
 
 For full changes, see the `Releases page <https://github.com/stan-dev/cmdstanpy/releases>`_ on GitHub.
 
+CmdStanPy 1.2.2
+---------------
+
+- Updated Community page to link to the ``bibat`` package.
+- Moved CmdStanPy's metadata to exclusively use the ``pyproject.toml`` file.
+- Fixed an issue where the deprecation of the ``compile=False`` argument to :class:`CmdStanModel` would
+  make it impossible to use the canonicalizer to update old models.
+  The new function :func:`cmdstanpy.format_stan_file` supports this use case.
+- Fixed a bug preventing multiple inits from being used with :meth:`CmdStanModel.pathfinder`.
+- Added a helper argument ``num_threads`` to :meth:`CmdStanModel.pathfinder`.
+
+Reminder: The next non-bugfix release of CmdStanPy will be version 2.0, which will remove all existing deprecations.
+
 CmdStanPy 1.2.1
 ---------------