Documentation: use JSON instead of the deprecated JSON3 once CTModels is released

オープン
#993 コメント 0 件 リアクション 0 件 担当者 1 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@ocots がすでに取り組んでいます。

2026年10月18日 から。

評価

この issue はまだ評価されていません。

説明

documentation

Context

JSON3.jl is deprecated in favour of JSON.jl v1. CTModels moves its JSON format to JSON.jl (control-toolbox/CTModels.jl#467, PR #468): the CTModelsJSON extension is then activated by using JSON instead of using JSON3, and JSON3Tag is renamed JSONTag. format=:JSON is unchanged and the files keep their format.

This is a breaking change of CTModels (0.20.0). Once it is released, the OptimalControl documentation must load JSON instead of JSON3, or the JSON examples will fail with an ExtensionError.

To update (after the CTModels release)

  • docs/make.jl: using JSON3 → using JSON.
  • docs/src/results/save-load.md:
    • the JSON section: the link to JSON3.jl → JSON.jl, and using JSON3 → using JSON;
    • the section "Without JLD2 or JSON3" (title and text): JSON; the ExtensionError for format=:JSON now names JSON.
  • docs/src/getting-started/installation.md: using JSON3 # format=:JSON → using JSON.
  • The documentation environments, which list JSON3 with its UUID and a [compat] entry: JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6" and JSON = "1" in
    • docs/Project.toml;
    • docs/src/assets/Project.toml;
    • docs/src/public/assets/Project.toml.
  • Check the notebook and script of the guided tour (docs/src/public/assets/guided-tour.*) and the pages that mention the formats.

Nothing in src/, ext/ or test/ of OptimalControl uses JSON3.

Related

  • control-toolbox/CTModels.jl#467, #468.
  • OptimalControl#992 (documentation of the multi-phase solutions), which depends on the same CTModels release.
主要言語
Julia
スター
135
フォーク
11
平均マージ
7時間 51分
マージ済み PR(30日)
22

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

control-toolbox/OptimalControl.jl のほかの issue

control-toolbox/OptimalControl.jl の issue をすべて見る

似ている issue

Julia の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。