QuantEcon / ContinuousDPs.jl

Continuous state dynamic programming
BSD 3-Clause "New" or "Revised" License
13 stars 10 forks source link

add docs for Methods and Solve methods #21

Closed tokuma09 closed 5 years ago

tokuma09 commented 5 years ago

This pull request adds some documents for Methods and Solve methods in cdp.jl.

Later I will add docs for Types, contructors and Simulate methods.

Document style is based on QuantEcon.jl.

oyamad commented 5 years ago

Thanks! For the doc style, please follow Games.jl rather than QuantEcon.jl (refer in particular to QuantEcon/Games.jl#25).

tokuma09 commented 5 years ago

I got it. Later on, I'm going to change doc style based on Ganes.jl.

tokuma09 commented 5 years ago

I rewrite docs for ContinuousDPs.jl for all functions and structs. I think this style is based on Games.jl.

oyamad commented 5 years ago

@tokupooh Thanks!

tokuma09 commented 5 years ago

@oyamad Sure. I'll fix them.

By the way, do we need same documents for different methods ?
For example, s_wise_max! allows several types of arguments, depending on the dimensions of the problem. However, an objective of all methods is same.(I know this function works in different way internally.)

In this pull request, I add explanation for each methods, but Julia does not provide it for all methods.

Should I follow their doc style?

oyamad commented 5 years ago

Yes, please provide a docstring to each method. (We can elaborate later if necessary.)

tokuma09 commented 5 years ago

I fix my docs for ContinuousDPs.jl by following the style where each line with 80 characters or fewer and type declaration.

In addition, explanation is consitent internally.

tokuma09 commented 5 years ago

Thanks for comments. I correct them.