Modify documentation. #34

shizejin · 2017-04-05T08:47:10Z

close #32.

Thanks very much for the suggestions of @oyamad and @sglyon!

Preview on my forked repo here.

oyamad · 2017-04-05T12:23:05Z

docs/src/index.md

+
+## [Lectures](@id lectures)
+
+Some lectures of this package is available on [QuantEcon](https://lectures.quantecon.org):


Better to say "notebooks" instead of "lectures".

oyamad · 2017-04-05T12:23:25Z

Thanks! Looks great.

QBatista · 2017-08-24T07:12:02Z

docs/src/index.md

@@ -0,0 +1,64 @@
+# Games.jl
+
+*Games.jl* is a [`Julia`](http://www.julialang.org) package for computation of Game Theory.


Games.jl is a Julia package for Game Theory related computations.

QBatista · 2017-08-24T07:12:42Z

docs/src/index.md

+
+## Installation
+
+*Games.jl* is an unregistered package that currently under development.


Games.jl is an unregistered package that is currently under development.

QBatista · 2017-08-24T07:13:36Z

docs/src/index.md

+player1 = Player([3 1; 0 2])
+```
+
+A 2-player `NormalFormGame` can be created either by passing `Player` instances.


A 2-player NormalFormGame can be created either by passing Player instances**,**

QBatista · 2017-08-24T07:14:06Z

docs/src/index.md

+g = NormalFormGame((player1, player2))
+```
+
+or by passing a payoff bimatrix directly.


or by passing a payoff matrix directly.
(to keep consistent with line 23)

QBatista · 2017-08-24T07:17:16Z

docs/src/index.md

+g = NormalFormGame(payoff_bimatrix)
+```
+
+After construction of `NormalFormGame`, we can find its Nash Equilibria by using methods of `Games`, for example, `pure_nash` finds all pure action Nash Equilibria by enumeration.


After constructing a NormalFormGame, we can find its Nash Equilibria by using methods in Games. For example, pure_nash is a method that finds all pure action Nash Equilibria by enumeration.

QBatista · 2017-08-24T07:27:25Z

docs/README.md

 ```

-The first line sets the order of pages. You can add a file name if you want it to generate a single page, or the name of section you want to create. In the following you need to declare which files are included in each section. Note that you shouldn't put a comma or dot at the end of each line.
+The first line sets the order of pages. You can add a file name if you want it to
+generate a single page, or the name of section you want to create. In the following


or the name of the section you want to create.

QBatista · 2017-08-24T07:28:19Z

docs/README.md

-The first line sets the order of pages. You can add a file name if you want it to generate a single page, or the name of section you want to create. In the following you need to declare which files are included in each section. Note that you shouldn't put a comma or dot at the end of each line.
+The first line sets the order of pages. You can add a file name if you want it to
+generate a single page, or the name of section you want to create. In the following
+you need to declare which files are included in each section. Note that you shouldn't


Note that you should not

QBatista · 2017-08-24T07:30:09Z

docs/README.md

+you need to declare which files are included in each section. Note that you shouldn't
+put a comma or dot at the end of each line.
+
+It is not necessary to declare structure for every file included in the Module.


It is not necessary to declare Structure for every file included in the Module.

I think I am referring to structure literally here, but not the file Structure.

Ok, then I think "It is not necessary to declare the structure of every file included in the Module." would be good?

QBatista · 2017-08-24T07:30:59Z

docs/README.md

+#### Homepage
+
+The Homepage is written in `/docs/src/index.md`. Please keep the last part in Homepage,
+called `Library Outline`, being empty. It will be filled by `auto_doc_gen.jl` automatically.


called Library Outline, empty.
(being is not needed)

QBatista · 2017-08-24T07:32:08Z

docs/README.md

-It is not necessary to declare structure for every file included in the Module. Files not mentioned in `Structure` will simply generate a single page automatically.
+This file includes information for "Documenter.jl" to generate documentation.
+Details [here](https://juliadocs.github.io/Documenter.jl/stable/man/guide.html#Output-formats-1)
+for how to use it.


Details on how to use it can be found here.

codecov-io · 2017-09-04T15:52:01Z

Codecov Report

Merging #34 into master will not change coverage.
The diff coverage is 100%.

@@           Coverage Diff           @@
##           master      #34   +/-   ##
=======================================
  Coverage   93.78%   93.78%           
=======================================
  Files           6        5    -1     
  Lines         338      338           
=======================================
  Hits          317      317           
  Misses         21       21

Impacted Files	Coverage Δ
src/random.jl	`100% <ø> (ø)`	⬆️
src/support_enumeration.jl	`98.66% <ø> (ø)`	⬆️
src/pure_nash.jl	`100% <ø> (ø)`	⬆️
src/normal_form_game.jl	`92.24% <ø> (ø)`	⬆️
src/repeated_game.jl	`90.43% <100%> (+0.71%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e5fe948...51c21eb. Read the comment docs.

coveralls · 2017-09-25T07:32:03Z

Changes Unknown when pulling 43dc2de on shizejin:modify_docs into ** on QuantEcon:master**.

coveralls · 2017-09-25T12:48:18Z

Changes Unknown when pulling 5b40851 on shizejin:modify_docs into ** on QuantEcon:master**.

coveralls · 2017-10-08T05:50:56Z

Changes Unknown when pulling 679fa03 on shizejin:modify_docs into ** on QuantEcon:master**.

coveralls · 2017-10-08T05:50:56Z

Changes Unknown when pulling 679fa03 on shizejin:modify_docs into ** on QuantEcon:master**.

coveralls · 2017-10-08T07:05:56Z

Changes Unknown when pulling 98412f6 on shizejin:modify_docs into ** on QuantEcon:master**.

shizejin · 2017-10-29T06:39:58Z

This is ready to be merged.

coveralls · 2017-10-29T07:03:33Z

Coverage remained the same at 93.787% when pulling 51c21eb on shizejin:modify_docs into e5fe948 on QuantEcon:master.

coveralls · 2017-10-29T07:03:33Z

Coverage remained the same at 93.787% when pulling 51c21eb on shizejin:modify_docs into e5fe948 on QuantEcon:master.

oyamad · 2017-11-01T05:51:35Z

Let me merge this as is. And then let's discuss for further improvements, if any, in a separate issue.

oyamad reviewed Apr 5, 2017

View reviewed changes

shizejin force-pushed the modify_docs branch from 8e66ada to c2d21ef Compare August 24, 2017 07:27

QBatista reviewed Aug 24, 2017

View reviewed changes

shizejin force-pushed the modify_docs branch from a3669e5 to eb205b6 Compare September 4, 2017 14:35

oyamad added the WIP label Sep 26, 2017

shizejin and others added 14 commits October 29, 2017 15:31

add guidance and modify structure.

8dda506

use "notebooks" instead of "lectures".

89f0ae3

Modify the docstrings for pure_nash.jl.

32e8e29

Correct English grammar.

08c5773

FIX: Modify documentation style up to line 330

9559ec2

FIX: Correct typo

454a426

Modify docstrings for normal_form_game.jl.

dfb3030

FIX: Add missing string to doc

07fa655

TEMP

4b2f97d

Modifications of docstring: * to - and shorten the header.

c97ccbb

FIX: Change the formatting of the doc for repeated_game

7a3f77f

FIX: Change the formatting of the doc for normal_form_game

10fc9d8

RFC: Move the unitcircle function to repeated_game

d2f7a92

RFC: Remove repeated_game_util.jl from Games.jl

51c21eb

shizejin force-pushed the modify_docs branch from 98412f6 to 51c21eb Compare October 29, 2017 06:37

shizejin added ready for review and removed WIP labels Oct 29, 2017

oyamad merged commit f9a2e25 into QuantEcon:master Nov 1, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Modify documentation. #34

Modify documentation. #34

shizejin commented Apr 5, 2017

oyamad Apr 5, 2017

oyamad commented Apr 5, 2017

QBatista Aug 24, 2017

QBatista Aug 24, 2017

QBatista Aug 24, 2017

QBatista Aug 24, 2017

QBatista Aug 24, 2017

QBatista Aug 24, 2017

QBatista Aug 24, 2017

QBatista Aug 24, 2017

shizejin Aug 24, 2017

QBatista Aug 24, 2017

QBatista Aug 24, 2017

QBatista Aug 24, 2017

codecov-io commented Sep 4, 2017 •

edited

Loading

coveralls commented Sep 25, 2017 •

edited

Loading

coveralls commented Sep 25, 2017 •

edited

Loading

coveralls commented Oct 8, 2017

coveralls commented Oct 8, 2017

coveralls commented Oct 8, 2017 •

edited

Loading

shizejin commented Oct 29, 2017

coveralls commented Oct 29, 2017

coveralls commented Oct 29, 2017

oyamad commented Nov 1, 2017


		## [Lectures](@id lectures)

		Some lectures of this package is available on [QuantEcon](https://lectures.quantecon.org):

		@@ -0,0 +1,64 @@
		# Games.jl

		Games.jl is a [`Julia`](http://www.julialang.org) package for computation of Game Theory.


		## Installation

		Games.jl is an unregistered package that currently under development.

Modify documentation. #34

Modify documentation. #34

Conversation

shizejin commented Apr 5, 2017

Choose a reason for hiding this comment

oyamad commented Apr 5, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-io commented Sep 4, 2017 • edited Loading

Codecov Report

coveralls commented Sep 25, 2017 • edited Loading

coveralls commented Sep 25, 2017 • edited Loading

coveralls commented Oct 8, 2017

coveralls commented Oct 8, 2017

coveralls commented Oct 8, 2017 • edited Loading

shizejin commented Oct 29, 2017

coveralls commented Oct 29, 2017

coveralls commented Oct 29, 2017

oyamad commented Nov 1, 2017

codecov-io commented Sep 4, 2017 •

edited

Loading

coveralls commented Sep 25, 2017 •

edited

Loading

coveralls commented Sep 25, 2017 •

edited

Loading

coveralls commented Oct 8, 2017 •

edited

Loading