Skip to content

Commit 63c69f6

Browse files
committed
docs: fix route_to and bypass documentation in advanced solve guide
- Correct route_to syntax to use strategy names (ipopt, madnlp, exa) instead of family names (solver, modeler, discretizer) - Fix ambiguous options explanation - only occurs when strategies from different families share option names within same method - Update bypass section with real Ipopt example using mumps_print_level - Add note about force alias for bypass - Remove redundant section about combining route_to and bypass - Expand describe output description - Fix markdown formatting issues
1 parent 2349652 commit 63c69f6

3 files changed

Lines changed: 291 additions & 136 deletions

File tree

docs/src/api/private.md

Lines changed: 223 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,223 @@
1+
```@meta
2+
EditURL = nothing
3+
```
4+
5+
# Private API
6+
7+
This page lists **non-exported** (internal) symbols of `OptimalControl`.
8+
9+
10+
---
11+
12+
### From `OptimalControl`
13+
14+
15+
## `DescriptiveMode`
16+
17+
```@docs
18+
OptimalControl.DescriptiveMode
19+
```
20+
21+
22+
## `ExplicitMode`
23+
24+
```@docs
25+
OptimalControl.ExplicitMode
26+
```
27+
28+
29+
## `SolveMode`
30+
31+
```@docs
32+
OptimalControl.SolveMode
33+
```
34+
35+
36+
## `_DEFAULT_DISPLAY`
37+
38+
```@docs
39+
OptimalControl._DEFAULT_DISPLAY
40+
```
41+
42+
43+
## `_DEFAULT_INITIAL_GUESS`
44+
45+
```@docs
46+
OptimalControl._DEFAULT_INITIAL_GUESS
47+
```
48+
49+
50+
## `_INITIAL_GUESS_ALIASES`
51+
52+
```@docs
53+
OptimalControl._INITIAL_GUESS_ALIASES
54+
```
55+
56+
57+
## `_INITIAL_GUESS_ALIASES_ONLY`
58+
59+
```@docs
60+
OptimalControl._INITIAL_GUESS_ALIASES_ONLY
61+
```
62+
63+
64+
## `_build_components_from_routed`
65+
66+
```@docs
67+
OptimalControl._build_components_from_routed
68+
```
69+
70+
71+
## `_build_or_use_strategy`
72+
73+
```@docs
74+
OptimalControl._build_or_use_strategy
75+
```
76+
77+
78+
## `_build_partial_description`
79+
80+
```@docs
81+
OptimalControl._build_partial_description
82+
```
83+
84+
85+
## `_build_partial_tuple`
86+
87+
```@docs
88+
OptimalControl._build_partial_tuple
89+
```
90+
91+
92+
## `_build_source_tag`
93+
94+
```@docs
95+
OptimalControl._build_source_tag
96+
```
97+
98+
99+
## `_complete_components`
100+
101+
```@docs
102+
OptimalControl._complete_components
103+
```
104+
105+
106+
## `_complete_description`
107+
108+
```@docs
109+
OptimalControl._complete_description
110+
```
111+
112+
113+
## `_descriptive_action_defs`
114+
115+
```@docs
116+
OptimalControl._descriptive_action_defs
117+
```
118+
119+
120+
## `_descriptive_families`
121+
122+
```@docs
123+
OptimalControl._descriptive_families
124+
```
125+
126+
127+
## `_determine_parameter_display_strategy`
128+
129+
```@docs
130+
OptimalControl._determine_parameter_display_strategy
131+
```
132+
133+
134+
## `_explicit_or_descriptive`
135+
136+
```@docs
137+
OptimalControl._explicit_or_descriptive
138+
```
139+
140+
141+
## `_extract_action_kwarg`
142+
143+
```@docs
144+
OptimalControl._extract_action_kwarg
145+
```
146+
147+
148+
## `_extract_kwarg`
149+
150+
```@docs
151+
OptimalControl._extract_kwarg
152+
```
153+
154+
155+
## `_extract_strategy_parameters`
156+
157+
```@docs
158+
OptimalControl._extract_strategy_parameters
159+
```
160+
161+
162+
## `_has_complete_components`
163+
164+
```@docs
165+
OptimalControl._has_complete_components
166+
```
167+
168+
169+
## `_print_component_with_param`
170+
171+
```@docs
172+
OptimalControl._print_component_with_param
173+
```
174+
175+
176+
## `_route_descriptive_options`
177+
178+
```@docs
179+
OptimalControl._route_descriptive_options
180+
```
181+
182+
183+
## `_unwrap_option`
184+
185+
```@docs
186+
OptimalControl._unwrap_option
187+
```
188+
189+
190+
## `display_ocp_configuration`
191+
192+
```@docs
193+
OptimalControl.display_ocp_configuration
194+
```
195+
196+
197+
## `get_strategy_registry`
198+
199+
```@docs
200+
OptimalControl.get_strategy_registry
201+
```
202+
203+
204+
## `solve_descriptive`
205+
206+
```@docs
207+
OptimalControl.solve_descriptive
208+
```
209+
210+
211+
## `solve_explicit`
212+
213+
```@docs
214+
OptimalControl.solve_explicit
215+
```
216+
217+
218+
## `will_solver_print`
219+
220+
```@docs
221+
OptimalControl.will_solver_print
222+
```
223+

0 commit comments

Comments
 (0)