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

Abierto
#993 0 comentarios 0 reacciones 1 asignado Ver en GitHub

Los mantenedores suelen responder en 1 día

@ocots ya está trabajando en esto.

Desde el 18/10/2026.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

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.
Lenguaje dominante
Julia
Estrellas
135
Forks
11
Merge medio
7 h 51 min
PR fusionados (30 d)
22

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de control-toolbox/OptimalControl.jl

Todos los issues de control-toolbox/OptimalControl.jl

Issues similares

Más issues de Julia

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.