JuliaReach / LazySets.jl

Scalable symbolic-numeric set computations in Julia
https://juliareach.github.io/LazySets.jl/
Other
226 stars 32 forks source link

Outsource documentation to API module #3497

Closed schillic closed 2 months ago

schillic commented 3 months ago

This is essentially a refactoring.

In the future, I imagine the following steps:

  1. Discuss whether more functions should be in API.
  2. Shorten lots of the common documentation, and possibly use # Extended help (last item (11.) here).
  3. Potentially revise the presentation of the API in the documentation.
  4. Eventually, API could get outsourced, e.g., to MathematicalSets. Some of the functions, like concretize, are probably too exotic for that, though.

The idea with 4. only came after I did these changes. If there is the intention to do 4., we should maybe discuss each of the functions I selected for API and whether they should stay in LazySets instead.