Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Todo list for documentation #32

Closed
5 tasks done
shizejin opened this issue Mar 29, 2017 · 3 comments · Fixed by #34
Closed
5 tasks done

Todo list for documentation #32

shizejin opened this issue Mar 29, 2017 · 3 comments · Fixed by #34
Assignees
Labels

Comments

@shizejin
Copy link
Member

shizejin commented Mar 29, 2017

  • Create a new section called "Base Types and Methods" which includes NormalFormGame.
  • Add random game to the section "Base Types and Methods".
  • Change auto_doc_gen.jl, so that each section does not have subsections for files, but just has subsections of "Exported" and "Internal".
  • Add a User Guide before Library.
  • Add a description to docs/README.md about how to use auto_doc_gen.jl.
@oyamad
Copy link
Member

oyamad commented Apr 5, 2017

@oyamad
Copy link
Member

oyamad commented Sep 23, 2017

  • Revise the docstrings for the repeated game related functions; see the documentation.

@oyamad
Copy link
Member

oyamad commented Sep 23, 2017

Remove the type declarations from the header. For example:

covariance_game{N}([rng::AbstractRNG], nums_actions::NTuple{N,Int}, 
                   rho::Real)

should be

covariance_game{N}([rng], nums_actions, rho)

or

covariance_game{N}([rng=GLOBAL_RNG], nums_actions, rho)

The type declarations are provided in the Arguments section.

@oyamad oyamad added the WIP label Oct 21, 2017
@oyamad oyamad closed this as completed in #34 Nov 1, 2017
@shizejin shizejin reopened this Nov 30, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants