Skip to content

Commit

Permalink
Fix changelog for Manopt 0.5.4 release (#429)
Browse files Browse the repository at this point in the history
* Fix changelog for Manopt 0.5.4 release

* fix extref?

* extref fix?

* fix extref  v3
  • Loading branch information
mateuszbaran authored Dec 11, 2024
1 parent f67ef6b commit 2aa8f62
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 9 deletions.
9 changes: 2 additions & 7 deletions Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,14 @@ All notable Changes to the Julia package `Manopt.jl` will be documented in this
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.5.5] - unreleased

### Added

* icons upfront external links when they link to another package or wikipedia.

## [0.5.4] - November 27, 2024
## [0.5.4] - December 11, 2024

### Added

* An automated detection whether the tutorials are present
if not an also no quarto run is done, an automated `--exlcude-tutorials` option is added.
* Support for ManifoldDiff 0.4
* icons upfront external links when they link to another package or wikipedia.

## [0.5.3] – October 18, 2024

Expand Down
5 changes: 3 additions & 2 deletions src/plans/constrained_plan.jl
Original file line number Diff line number Diff line change
Expand Up @@ -992,14 +992,15 @@ g_i(p) ≤ 0, \text{ for all } i=1,…,m\quad\text{ and }\quad h_j(p) = 0, \text
```
# Keyword arguments
* `check_point::Bool=true`: whether to also verify that ``p∈\mathcal M` holds, using [`is_point`](@extref ManifoldsBase.is_point)
* `check_point::Bool=true`: whether to also verify that ``p∈\mathcal M` holds, using [`is_point`](@extref ManifoldsBase :jl:method:`ManifoldsBase.is_point-Tuple{AbstractManifold, Any, Bool}`)
* `error::Symbol=:none`: if the point is not feasible, this symbol determines how to report the error.
* `:error`: throws an error
* `:info`: displays the error message as an @info
* `:none`: (default) the function just returns true/false
* `:warn`: displays the error message as a @warning.
The keyword `error=` and all other `kwargs...` are passed on to [`is_point`](@extref ManifoldsBase.is_point) if the point is verfied (see `check_point`).
The keyword `error=` and all other `kwargs...` are passed on to [`is_point`](@extref ManifoldsBase :jl:method:`ManifoldsBase.is_point-Tuple{AbstractManifold, Any, Bool}`)
if the point is verfied (see `check_point`).
All other keywords are passed on to `is_poi`
"""
Expand Down

2 comments on commit 2aa8f62

@mateuszbaran
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

Release notes:

Added

  • An automated detection whether the tutorials are present
    if not an also no quarto run is done, an automated --exlcude-tutorials option is added.
  • Support for ManifoldDiff 0.4
  • icons upfront external links when they link to another package or wikipedia.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/121194

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.5.4 -m "<description of version>" 2aa8f6206daaeda676cf3c97ad0e19e17915c50d
git push origin v0.5.4

Please sign in to comment.