docs: add missing guides and update listings#489
Merged
Conversation
Add three new guides for previously undocumented submodules: - guide/interpolation.md: linear and piecewise-constant interpolation - guide/unicode.md: subscript/superscript character helpers - guide/plotting.md: backend-agnostic plotting IR and render contract Update existing guides to cover missing exported types: - guide/data.md: add PathConstraint (StateConstraint/ControlConstraint/MixedConstraint) and Multiplier sections - guide/traits.md: add Constraint kind trait family (AbstractConstraintKind, StateConstraintKind, ControlConstraintKind, MixedConstraintKind) Update documentation listings: - index.md: add Plotting to module table, add 4 guides to User Guides list - make.jl: add Utilities section with 3 new guides in pages array - getting-started.md: add 4 new guides to Next Steps table
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds missing documentation guides and updates existing guides to cover all exported public API.
New guides
guide/interpolation.md— linear and piecewise-constant interpolation with flat extrapolation (ctinterpolate,ctinterpolate_constant,Interpolant).guide/unicode.md— Unicode subscript/superscript helpers (ctindice,ctindices,ctupperscript,ctupperscripts).guide/plotting.md— backend-agnostic plotting IR:Series,Axes, layout tree (Leaf/HBox/VBox/Figure),Panel,lower, combinators (Stacked/Paired/Grid), backend contract (render/render!).Updated guides
guide/data.md— addedPathConstraint(StateConstraint/ControlConstraint/MixedConstraint) andMultipliersections, updated overview table (8 → 10 types), typed constructors, and See Also.guide/traits.md— added Constraint kind trait family (AbstractConstraintKind,StateConstraintKind,ControlConstraintKind,MixedConstraintKind) with accessor and predicates, updated summary table.Updated listings
index.md— addedPlottingto module table, added 4 guides (Color System, Interpolation, Unicode Helpers, Plotting Engine) to User Guides list.make.jl— added "Utilities" section with 3 new guides in thepagesarray.getting-started.md— added 4 new guides to the Next Steps table.Checklist
@meta,@repl/@exampleblocks, function reference tables, See Also)index.md,make.jl, andgetting-started.md