Merge pull request #168 from control-toolbox/167-doc-add-warning-message

Add warning message

Author: ocots

Project.toml

@@ -1,7 +1,7 @@
 name = "CTModels"
 uuid = "34c4fa32-2049-4079-8329-de33c2a22e2d"
 authors = ["Olivier Cots <olivier.cots@toulouse-inp.fr>"]
-version = "0.5.3"
+version = "0.5.4"
 
 [deps]
 CTBase = "54762871-cc72-4466-b8e8-f6c8b58076cd"

docs/src/constraints.md

@@ -8,6 +8,36 @@ Modules = [CTModels, Base]
 Order = [:module, :constant, :type, :function, :macro]
 ```
 
+!!! warning
+
+    In the examples in the documentation below, the methods are not prefixed by the module name even if they are private. 
+
+    ```julia-repl
+    julia> using CTModels
+    julia> x = 1
+    julia> private_fun(x) # throw an error
+    ```
+
+    must be replaced by
+
+    ```julia-repl
+    julia> using CTModels
+    julia> x = 1
+    julia> CTModels.private_fun(x)
+    ```
+
+    However, if the method is reexported by another package, then, there is no need of prefixing.
+
+    ```julia-repl
+    julia> module OptimalControl
+               import CTModels: private_fun
+               export private_fun
+           end
+    julia> using OptimalControl
+    julia> x = 1
+    julia> private_fun(x)
+    ```
+
 ## Documentation
 
 ```@autodocs

docs/src/control.md

@@ -8,6 +8,36 @@ Modules = [CTModels]
 Order = [:module, :constant, :type, :function, :macro]
 ```
 
+!!! warning
+
+    In the examples in the documentation below, the methods are not prefixed by the module name even if they are private. 
+
+    ```julia-repl
+    julia> using CTModels
+    julia> x = 1
+    julia> private_fun(x) # throw an error
+    ```
+
+    must be replaced by
+
+    ```julia-repl
+    julia> using CTModels
+    julia> x = 1
+    julia> CTModels.private_fun(x)
+    ```
+
+    However, if the method is reexported by another package, then, there is no need of prefixing.
+
+    ```julia-repl
+    julia> module OptimalControl
+               import CTModels: private_fun
+               export private_fun
+           end
+    julia> using OptimalControl
+    julia> x = 1
+    julia> private_fun(x)
+    ```
+
 ## Documentation
 
 ```@autodocs

docs/src/ctmodels.md

@@ -8,6 +8,36 @@ Modules = [CTModels, RecipesBase]
 Order = [:module, :constant, :type, :function, :macro]
 ```
 
+!!! warning
+
+    In the examples in the documentation below, the methods are not prefixed by the module name even if they are private. 
+
+    ```julia-repl
+    julia> using CTModels
+    julia> x = 1
+    julia> private_fun(x) # throw an error
+    ```
+
+    must be replaced by
+
+    ```julia-repl
+    julia> using CTModels
+    julia> x = 1
+    julia> CTModels.private_fun(x)
+    ```
+
+    However, if the method is reexported by another package, then, there is no need of prefixing.
+
+    ```julia-repl
+    julia> module OptimalControl
+               import CTModels: private_fun
+               export private_fun
+           end
+    julia> using OptimalControl
+    julia> x = 1
+    julia> private_fun(x)
+    ```
+
 ## Documentation
 
 ```@autodocs

docs/src/dynamics.md

@@ -8,6 +8,36 @@ Modules = [CTModels]
 Order = [:module, :constant, :type, :function, :macro]
 ```
 
+!!! warning
+
+    In the examples in the documentation below, the methods are not prefixed by the module name even if they are private. 
+
+    ```julia-repl
+    julia> using CTModels
+    julia> x = 1
+    julia> private_fun(x) # throw an error
+    ```
+
+    must be replaced by
+
+    ```julia-repl
+    julia> using CTModels
+    julia> x = 1
+    julia> CTModels.private_fun(x)
+    ```
+
+    However, if the method is reexported by another package, then, there is no need of prefixing.
+
+    ```julia-repl
+    julia> module OptimalControl
+               import CTModels: private_fun
+               export private_fun
+           end
+    julia> using OptimalControl
+    julia> x = 1
+    julia> private_fun(x)
+    ```
+
 ## Documentation
 
 ```@autodocs

docs/src/init.md

@@ -8,6 +8,36 @@ Modules = [CTModels]
 Order = [:module, :constant, :type, :function, :macro]
 ```
 
+!!! warning
+
+    In the examples in the documentation below, the methods are not prefixed by the module name even if they are private. 
+
+    ```julia-repl
+    julia> using CTModels
+    julia> x = 1
+    julia> private_fun(x) # throw an error
+    ```
+
+    must be replaced by
+
+    ```julia-repl
+    julia> using CTModels
+    julia> x = 1
+    julia> CTModels.private_fun(x)
+    ```
+
+    However, if the method is reexported by another package, then, there is no need of prefixing.
+
+    ```julia-repl
+    julia> module OptimalControl
+               import CTModels: private_fun
+               export private_fun
+           end
+    julia> using OptimalControl
+    julia> x = 1
+    julia> private_fun(x)
+    ```
+
 ## Documentation
 
 ```@autodocs

docs/src/jld.md

@@ -8,6 +8,36 @@ Modules = [CTModels, CTModelsJLD]
 Order = [:module, :constant, :type, :function, :macro]
 ```
 
+!!! warning
+
+    In the examples in the documentation below, the methods are not prefixed by the module name even if they are private. 
+
+    ```julia-repl
+    julia> using CTModels
+    julia> x = 1
+    julia> private_fun(x) # throw an error
+    ```
+
+    must be replaced by
+
+    ```julia-repl
+    julia> using CTModels
+    julia> x = 1
+    julia> CTModels.private_fun(x)
+    ```
+
+    However, if the method is reexported by another package, then, there is no need of prefixing.
+
+    ```julia-repl
+    julia> module OptimalControl
+               import CTModels: private_fun
+               export private_fun
+           end
+    julia> using OptimalControl
+    julia> x = 1
+    julia> private_fun(x)
+    ```
+
 ## Documentation
 
 ```@autodocs

docs/src/json.md

@@ -8,6 +8,36 @@ Modules = [CTModels, CTModelsJSON]
 Order = [:module, :constant, :type, :function, :macro]
 ```
 
+!!! warning
+
+    In the examples in the documentation below, the methods are not prefixed by the module name even if they are private. 
+
+    ```julia-repl
+    julia> using CTModels
+    julia> x = 1
+    julia> private_fun(x) # throw an error
+    ```
+
+    must be replaced by
+
+    ```julia-repl
+    julia> using CTModels
+    julia> x = 1
+    julia> CTModels.private_fun(x)
+    ```
+
+    However, if the method is reexported by another package, then, there is no need of prefixing.
+
+    ```julia-repl
+    julia> module OptimalControl
+               import CTModels: private_fun
+               export private_fun
+           end
+    julia> using OptimalControl
+    julia> x = 1
+    julia> private_fun(x)
+    ```
+
 ## Documentation
 
 ```@autodocs

docs/src/model.md

@@ -8,6 +8,36 @@ Modules = [CTModels]
 Order = [:module, :constant, :type, :function, :macro]
 ```
 
+!!! warning
+
+    In the examples in the documentation below, the methods are not prefixed by the module name even if they are private. 
+
+    ```julia-repl
+    julia> using CTModels
+    julia> x = 1
+    julia> private_fun(x) # throw an error
+    ```
+
+    must be replaced by
+
+    ```julia-repl
+    julia> using CTModels
+    julia> x = 1
+    julia> CTModels.private_fun(x)
+    ```
+
+    However, if the method is reexported by another package, then, there is no need of prefixing.
+
+    ```julia-repl
+    julia> module OptimalControl
+               import CTModels: private_fun
+               export private_fun
+           end
+    julia> using OptimalControl
+    julia> x = 1
+    julia> private_fun(x)
+    ```
+
 ## Documentation
 
 ```@autodocs

docs/src/objective.md

@@ -8,6 +8,36 @@ Modules = [CTModels]
 Order = [:module, :constant, :type, :function, :macro]
 ```
 
+!!! warning
+
+    In the examples in the documentation below, the methods are not prefixed by the module name even if they are private. 
+
+    ```julia-repl
+    julia> using CTModels
+    julia> x = 1
+    julia> private_fun(x) # throw an error
+    ```
+
+    must be replaced by
+
+    ```julia-repl
+    julia> using CTModels
+    julia> x = 1
+    julia> CTModels.private_fun(x)
+    ```
+
+    However, if the method is reexported by another package, then, there is no need of prefixing.
+
+    ```julia-repl
+    julia> module OptimalControl
+               import CTModels: private_fun
+               export private_fun
+           end
+    julia> using OptimalControl
+    julia> x = 1
+    julia> private_fun(x)
+    ```
+
 ## Documentation
 
 ```@autodocs